@open-captable-protocol/canton 0.2.178 → 0.2.179

package/dist/functions/OpenCapTable/stockPlan/createStockPlan.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createStockPlan.d.ts","sourceRoot":"","sources":["../../../../src/functions/OpenCapTable/stockPlan/createStockPlan.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,0CAA0C,CAAC;AAEzE,OAAO,KAAK,EAAE,YAAY,EAAiC,MAAM,gBAAgB,CAAC;AA2BlF,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,YAAY,GAAG,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,gBAAgB,CAyBzG"}
+{"version":3,"file":"createStockPlan.d.ts","sourceRoot":"","sources":["../../../../src/functions/OpenCapTable/stockPlan/createStockPlan.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,0CAA0C,CAAC;AAEzE,OAAO,KAAK,EAAE,YAAY,EAAiC,MAAM,gBAAgB,CAAC;AAyBlF,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,YAAY,GAAG,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,gBAAgB,CA0BzG"}

package/dist/functions/OpenCapTable/stockPlan/createStockPlan.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.stockPlanDataToDaml = stockPlanDataToDaml;
 const errors_1 = require("../../../errors");
+const deprecatedFieldNormalization_1 = require("../../../utils/deprecatedFieldNormalization");
 const typeConversions_1 = require("../../../utils/typeConversions");
 function cancellationBehaviorToDaml(b) {
     if (!b)
@@ -26,11 +27,9 @@ function stockPlanDataToDaml(d) {
             receivedValue: d.id,
         });
     }
-    // Handle deprecated stock_class_id → stock_class_ids
-    // Cast to allow for deprecated field and potentially missing stock_class_ids (when only deprecated field is provided)
-    const data = d;
-    const currentIds = data.stock_class_ids ?? [];
-    const stockClassIds = currentIds.length > 0 ? currentIds : data.stock_class_id ? [data.stock_class_id] : [];
+    // Normalize deprecated stock_class_id → stock_class_ids using centralized helper
+    // Cast to allow for deprecated field which may be present in older OCF data
+    const { stock_class_ids } = (0, deprecatedFieldNormalization_1.normalizeDeprecatedStockPlanFields)(d, 'stockPlan.create');
     return {
         id: d.id,
         plan_name: d.plan_name,
@@ -38,7 +37,7 @@ function stockPlanDataToDaml(d) {
         stockholder_approval_date: d.stockholder_approval_date ? (0, typeConversions_1.dateStringToDAMLTime)(d.stockholder_approval_date) : null,
         initial_shares_reserved: typeof d.initial_shares_reserved === 'number' ? d.initial_shares_reserved.toString() : d.initial_shares_reserved,
         default_cancellation_behavior: cancellationBehaviorToDaml(d.default_cancellation_behavior),
-        stock_class_ids: stockClassIds,
+        stock_class_ids,
         comments: (0, typeConversions_1.cleanComments)(d.comments),
     };
 }

package/dist/functions/OpenCapTable/stockPlan/createStockPlan.js.map

@@ -1 +1 @@
-{"version":3,"file":"createStockPlan.js","sourceRoot":"","sources":["../../../../src/functions/OpenCapTable/stockPlan/createStockPlan.ts"],"names":[],"mappings":";;AA6BA,kDAyBC;AArDD,4CAAqD;AAErD,oEAAqF;AAErF,SAAS,0BAA0B,CACjC,CAA4C;IAE5C,IAAI,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IACpB,QAAQ,CAAC,EAAE,CAAC;QACV,KAAK,QAAQ;YACX,OAAO,qBAAqB,CAAC;QAC/B,KAAK,gBAAgB;YACnB,OAAO,2BAA2B,CAAC;QACrC,KAAK,uBAAuB;YAC1B,OAAO,iCAAiC,CAAC;QAC3C,KAAK,2BAA2B;YAC9B,OAAO,qCAAqC,CAAC;QAC/C;YACE,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACrD,CAAC;AACH,CAAC;AAQD,SAAgB,mBAAmB,CAAC,CAAe;IACjD,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACV,MAAM,IAAI,2BAAkB,CAAC,cAAc,EAAE,oCAAoC,EAAE;YACjF,YAAY,EAAE,QAAQ;YACtB,aAAa,EAAE,CAAC,CAAC,EAAE;SACpB,CAAC,CAAC;IACL,CAAC;IAED,qDAAqD;IACrD,sHAAsH;IACtH,MAAM,IAAI,GAAG,CAAgC,CAAC;IAC9C,MAAM,UAAU,GAAG,IAAI,CAAC,eAAe,IAAI,EAAE,CAAC;IAC9C,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAE5G,OAAO;QACL,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,SAAS,EAAE,CAAC,CAAC,SAAS;QACtB,mBAAmB,EAAE,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAA,sCAAoB,EAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,IAAI;QAC/F,yBAAyB,EAAE,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,IAAA,sCAAoB,EAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,IAAI;QACjH,uBAAuB,EACrB,OAAO,CAAC,CAAC,uBAAuB,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,uBAAuB,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,uBAAuB;QAClH,6BAA6B,EAAE,0BAA0B,CAAC,CAAC,CAAC,6BAA6B,CAAC;QAC1F,eAAe,EAAE,aAAa;QAC9B,QAAQ,EAAE,IAAA,+BAAa,EAAC,CAAC,CAAC,QAAQ,CAAC;KACpC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"createStockPlan.js","sourceRoot":"","sources":["../../../../src/functions/OpenCapTable/stockPlan/createStockPlan.ts"],"names":[],"mappings":";;AA2BA,kDA0BC;AApDD,4CAAqD;AAErD,8FAGqD;AACrD,oEAAqF;AAErF,SAAS,0BAA0B,CACjC,CAA4C;IAE5C,IAAI,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IACpB,QAAQ,CAAC,EAAE,CAAC;QACV,KAAK,QAAQ;YACX,OAAO,qBAAqB,CAAC;QAC/B,KAAK,gBAAgB;YACnB,OAAO,2BAA2B,CAAC;QACrC,KAAK,uBAAuB;YAC1B,OAAO,iCAAiC,CAAC;QAC3C,KAAK,2BAA2B;YAC9B,OAAO,qCAAqC,CAAC;QAC/C;YACE,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACrD,CAAC;AACH,CAAC;AAED,SAAgB,mBAAmB,CAAC,CAAe;IACjD,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACV,MAAM,IAAI,2BAAkB,CAAC,cAAc,EAAE,oCAAoC,EAAE;YACjF,YAAY,EAAE,QAAQ;YACtB,aAAa,EAAE,CAAC,CAAC,EAAE;SACpB,CAAC,CAAC;IACL,CAAC;IAED,iFAAiF;IACjF,4EAA4E;IAC5E,MAAM,EAAE,eAAe,EAAE,GAAG,IAAA,iEAAkC,EAC5D,CAAqC,EACrC,kBAAkB,CACnB,CAAC;IAEF,OAAO;QACL,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,SAAS,EAAE,CAAC,CAAC,SAAS;QACtB,mBAAmB,EAAE,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAA,sCAAoB,EAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,IAAI;QAC/F,yBAAyB,EAAE,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,IAAA,sCAAoB,EAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,IAAI;QACjH,uBAAuB,EACrB,OAAO,CAAC,CAAC,uBAAuB,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,uBAAuB,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,uBAAuB;QAClH,6BAA6B,EAAE,0BAA0B,CAAC,CAAC,CAAC,6BAA6B,CAAC;QAC1F,eAAe;QACf,QAAQ,EAAE,IAAA,+BAAa,EAAC,CAAC,CAAC,QAAQ,CAAC;KACpC,CAAC;AACJ,CAAC"}

package/dist/utils/deprecatedFieldNormalization.d.ts

@@ -0,0 +1,219 @@
+/**
+ * Utilities for normalizing deprecated OCF fields to their current equivalents.
+ *
+ * OCF schema evolves over time, and some fields are deprecated in favor of new ones.
+ * These utilities provide type-safe normalization and verification helpers.
+ *
+ * @example
+ *   ```typescript
+ *   import { normalizeSingularToArray, normalizeDeprecatedStockPlanFields } from './deprecatedFieldNormalization';
+ *
+ *   // Generic singular → array normalization
+ *   const stockClassIds = normalizeSingularToArray({
+ *     singularValue: data.stock_class_id,
+ *     arrayValue: data.stock_class_ids,
+ *   });
+ *
+ *   // Stock plan specific helper
+ *   const normalized = normalizeDeprecatedStockPlanFields(inputData);
+ *   ```
+ */
+/**
+ * Configuration for deprecation warnings.
+ * Can be customized for testing or production environments.
+ */
+export interface DeprecationWarningConfig {
+    /** Whether to emit console warnings for deprecated field usage (default: true in development) */
+    enabled: boolean;
+    /** Custom warning handler (default: console.warn) */
+    handler?: (message: string, details: DeprecationDetails) => void;
+}
+/**
+ * Details about a deprecated field usage.
+ */
+export interface DeprecationDetails {
+    /** Name of the deprecated field */
+    deprecatedField: string;
+    /** Name of the replacement field */
+    replacementField: string;
+    /** The deprecated value that was provided */
+    deprecatedValue: unknown;
+    /** Context about where the deprecation occurred */
+    context?: string;
+}
+/**
+ * Global deprecation warning configuration.
+ * Can be modified for testing or to customize warning behavior.
+ */
+export declare const deprecationWarningConfig: DeprecationWarningConfig;
+/**
+ * Emit a deprecation warning.
+ *
+ * @param details - Details about the deprecated field usage
+ */
+export declare function emitDeprecationWarning(details: DeprecationDetails): void;
+/**
+ * Parameters for normalizing a singular deprecated field to an array field.
+ */
+export interface SingularToArrayParams<T> {
+    /** The deprecated singular value (may be undefined) */
+    singularValue: T | undefined;
+    /** The current array value (may be undefined or empty) */
+    arrayValue: T[] | undefined;
+    /** Name of the deprecated field (for warnings) */
+    deprecatedFieldName?: string;
+    /** Name of the replacement field (for warnings) */
+    replacementFieldName?: string;
+    /** Context for the warning message */
+    context?: string;
+}
+/**
+ * Normalize a deprecated singular field to an array field.
+ *
+ * When both singular and array values are provided, the array takes precedence.
+ * If the array is empty/undefined but singular has a value, wraps it in an array.
+ *
+ * @param params - Parameters for the normalization
+ * @returns The normalized array value (empty array if both inputs are empty/undefined)
+ *
+ * @example
+ *   ```typescript
+ *   // Only deprecated field provided
+ *   normalizeSingularToArray({
+ *     singularValue: 'class-1',
+ *     arrayValue: undefined,
+ *   }); // Returns ['class-1']
+ *
+ *   // Both provided - array takes precedence
+ *   normalizeSingularToArray({
+ *     singularValue: 'class-1',
+ *     arrayValue: ['class-2', 'class-3'],
+ *   }); // Returns ['class-2', 'class-3']
+ *
+ *   // Neither provided
+ *   normalizeSingularToArray({
+ *     singularValue: undefined,
+ *     arrayValue: undefined,
+ *   }); // Returns []
+ *   ```
+ */
+export declare function normalizeSingularToArray<T>(params: SingularToArrayParams<T>): T[];
+/**
+ * Input type that may contain deprecated stock_class_id field.
+ * This matches OCF data that may come from older schemas.
+ *
+ * Note: Fields can be null (not just undefined) when parsing JSON data from external sources.
+ */
+export interface StockPlanDataWithDeprecatedField {
+    /** The current array field for stock class associations */
+    stock_class_ids?: string[] | null;
+    /** @deprecated Use stock_class_ids instead. Deprecated field from older OCF versions. */
+    stock_class_id?: string | null;
+}
+/**
+ * Result of normalizing deprecated stock plan fields.
+ */
+export interface NormalizedStockPlanFields {
+    /** Normalized array of stock class IDs */
+    stock_class_ids: string[];
+    /** Whether a deprecated field was used */
+    usedDeprecatedField: boolean;
+}
+/**
+ * Normalize deprecated stock plan fields.
+ *
+ * Handles the OCF deprecation of `stock_class_id` (singular) → `stock_class_ids` (array).
+ *
+ * @param data - Stock plan data that may contain deprecated fields
+ * @param context - Optional context for deprecation warnings (e.g., "stockPlan.create")
+ * @returns Object containing normalized stock_class_ids and deprecation usage flag
+ *
+ * @example
+ *   ```typescript
+ *   // Old format (deprecated)
+ *   const result = normalizeDeprecatedStockPlanFields({
+ *     stock_class_id: 'sc-1',
+ *   });
+ *   // Returns { stock_class_ids: ['sc-1'], usedDeprecatedField: true }
+ *
+ *   // New format
+ *   const result = normalizeDeprecatedStockPlanFields({
+ *     stock_class_ids: ['sc-1', 'sc-2'],
+ *   });
+ *   // Returns { stock_class_ids: ['sc-1', 'sc-2'], usedDeprecatedField: false }
+ *   ```
+ */
+export declare function normalizeDeprecatedStockPlanFields(data: StockPlanDataWithDeprecatedField, context?: string): NormalizedStockPlanFields;
+/**
+ * Result of checking for deprecated field usage.
+ */
+export interface DeprecatedFieldUsageResult {
+    /** Whether any deprecated fields were detected */
+    hasDeprecatedFields: boolean;
+    /** List of deprecated fields that were used */
+    deprecatedFieldsUsed: string[];
+}
+/**
+ * Check stock plan data for deprecated field usage without modifying the data.
+ *
+ * @param data - Stock plan data to check
+ * @returns Result indicating whether deprecated fields were used
+ *
+ * @example
+ *   ```typescript
+ *   const result = checkStockPlanDeprecatedFieldUsage({
+ *     stock_class_id: 'sc-1', // deprecated
+ *   });
+ *   // Returns { hasDeprecatedFields: true, deprecatedFieldsUsed: ['stock_class_id'] }
+ *   ```
+ */
+export declare function checkStockPlanDeprecatedFieldUsage(data: StockPlanDataWithDeprecatedField): DeprecatedFieldUsageResult;
+/**
+ * Configuration for a deprecated field mapping.
+ */
+export interface DeprecatedFieldMapping {
+    /** The deprecated field name */
+    deprecatedField: string;
+    /** The replacement field name */
+    replacementField: string;
+    /** The type of deprecation (singular_to_array, renamed, etc.) */
+    deprecationType: 'singular_to_array' | 'renamed' | 'removed';
+}
+/**
+ * Known OCF deprecated field mappings.
+ * Add new deprecations here as they are discovered.
+ */
+export declare const OCF_DEPRECATED_FIELDS: Record<string, DeprecatedFieldMapping[]>;
+/**
+ * Get the list of deprecated field mappings for an OCF object type.
+ *
+ * @param objectType - The OCF object type name (e.g., 'StockPlan')
+ * @returns Array of deprecated field mappings for the object type
+ */
+export declare function getDeprecatedFieldMappings(objectType: string): DeprecatedFieldMapping[];
+/**
+ * Check if a specific field is deprecated for an OCF object type.
+ *
+ * @param objectType - The OCF object type name
+ * @param fieldName - The field name to check
+ * @returns The deprecation mapping if the field is deprecated, undefined otherwise
+ */
+export declare function getFieldDeprecation(objectType: string, fieldName: string): DeprecatedFieldMapping | undefined;
+/**
+ * Check an object for any deprecated field usage based on known deprecations.
+ *
+ * @param objectType - The OCF object type name
+ * @param data - The object data to check
+ * @returns Result indicating which deprecated fields were used
+ *
+ * @example
+ *   ```typescript
+ *   const result = checkDeprecatedFields('StockPlan', {
+ *     stock_class_id: 'sc-1', // deprecated
+ *     plan_name: 'Equity Plan',
+ *   });
+ *   // Returns { hasDeprecatedFields: true, deprecatedFieldsUsed: ['stock_class_id'] }
+ *   ```
+ */
+export declare function checkDeprecatedFields(objectType: string, data: Record<string, unknown>): DeprecatedFieldUsageResult;
+//# sourceMappingURL=deprecatedFieldNormalization.d.ts.map

package/dist/utils/deprecatedFieldNormalization.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deprecatedFieldNormalization.d.ts","sourceRoot":"","sources":["../../src/utils/deprecatedFieldNormalization.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAIH;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,iGAAiG;IACjG,OAAO,EAAE,OAAO,CAAC;IACjB,qDAAqD;IACrD,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,KAAK,IAAI,CAAC;CAClE;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,mCAAmC;IACnC,eAAe,EAAE,MAAM,CAAC;IACxB,oCAAoC;IACpC,gBAAgB,EAAE,MAAM,CAAC;IACzB,6CAA6C;IAC7C,eAAe,EAAE,OAAO,CAAC;IACzB,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,eAAO,MAAM,wBAAwB,EAAE,wBAGtC,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,kBAAkB,GAAG,IAAI,CAexE;AAID;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,uDAAuD;IACvD,aAAa,EAAE,CAAC,GAAG,SAAS,CAAC;IAC7B,0DAA0D;IAC1D,UAAU,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC;IAC5B,kDAAkD;IAClD,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,mDAAmD;IACnD,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,sCAAsC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,EAAE,MAAM,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAwBjF;AAID;;;;;GAKG;AACH,MAAM,WAAW,gCAAgC;IAC/C,2DAA2D;IAC3D,eAAe,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAClC,yFAAyF;IACzF,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,0CAA0C;IAC1C,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,0CAA0C;IAC1C,mBAAmB,EAAE,OAAO,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,kCAAkC,CAChD,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,MAAM,GACf,yBAAyB,CAyB3B;AAID;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,kDAAkD;IAClD,mBAAmB,EAAE,OAAO,CAAC;IAC7B,+CAA+C;IAC/C,oBAAoB,EAAE,MAAM,EAAE,CAAC;CAChC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kCAAkC,CAAC,IAAI,EAAE,gCAAgC,GAAG,0BAA0B,CAYrH;AAID;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,gCAAgC;IAChC,eAAe,EAAE,MAAM,CAAC;IACxB,iCAAiC;IACjC,gBAAgB,EAAE,MAAM,CAAC;IACzB,iEAAiE;IACjE,eAAe,EAAE,mBAAmB,GAAG,SAAS,GAAG,SAAS,CAAC;CAC9D;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,EAAE,CAQ1E,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,UAAU,EAAE,MAAM,GAAG,sBAAsB,EAAE,CAEvF;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,sBAAsB,GAAG,SAAS,CAG7G;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,0BAA0B,CAgBnH"}

package/dist/utils/deprecatedFieldNormalization.js

@@ -0,0 +1,244 @@
+"use strict";
+/**
+ * Utilities for normalizing deprecated OCF fields to their current equivalents.
+ *
+ * OCF schema evolves over time, and some fields are deprecated in favor of new ones.
+ * These utilities provide type-safe normalization and verification helpers.
+ *
+ * @example
+ *   ```typescript
+ *   import { normalizeSingularToArray, normalizeDeprecatedStockPlanFields } from './deprecatedFieldNormalization';
+ *
+ *   // Generic singular → array normalization
+ *   const stockClassIds = normalizeSingularToArray({
+ *     singularValue: data.stock_class_id,
+ *     arrayValue: data.stock_class_ids,
+ *   });
+ *
+ *   // Stock plan specific helper
+ *   const normalized = normalizeDeprecatedStockPlanFields(inputData);
+ *   ```
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OCF_DEPRECATED_FIELDS = exports.deprecationWarningConfig = void 0;
+exports.emitDeprecationWarning = emitDeprecationWarning;
+exports.normalizeSingularToArray = normalizeSingularToArray;
+exports.normalizeDeprecatedStockPlanFields = normalizeDeprecatedStockPlanFields;
+exports.checkStockPlanDeprecatedFieldUsage = checkStockPlanDeprecatedFieldUsage;
+exports.getDeprecatedFieldMappings = getDeprecatedFieldMappings;
+exports.getFieldDeprecation = getFieldDeprecation;
+exports.checkDeprecatedFields = checkDeprecatedFields;
+/**
+ * Global deprecation warning configuration.
+ * Can be modified for testing or to customize warning behavior.
+ */
+exports.deprecationWarningConfig = {
+    enabled: process.env.NODE_ENV !== 'test',
+    handler: undefined,
+};
+/**
+ * Emit a deprecation warning.
+ *
+ * @param details - Details about the deprecated field usage
+ */
+function emitDeprecationWarning(details) {
+    if (!exports.deprecationWarningConfig.enabled) {
+        return;
+    }
+    const message = `[OCF Deprecation] Field '${details.deprecatedField}' is deprecated. ` +
+        `Use '${details.replacementField}' instead.${details.context ? ` Context: ${details.context}` : ''}`;
+    if (exports.deprecationWarningConfig.handler) {
+        exports.deprecationWarningConfig.handler(message, details);
+    }
+    else {
+        // eslint-disable-next-line no-console -- Intentional deprecation warning to help developers migrate to current API
+        console.warn(message);
+    }
+}
+/**
+ * Normalize a deprecated singular field to an array field.
+ *
+ * When both singular and array values are provided, the array takes precedence.
+ * If the array is empty/undefined but singular has a value, wraps it in an array.
+ *
+ * @param params - Parameters for the normalization
+ * @returns The normalized array value (empty array if both inputs are empty/undefined)
+ *
+ * @example
+ *   ```typescript
+ *   // Only deprecated field provided
+ *   normalizeSingularToArray({
+ *     singularValue: 'class-1',
+ *     arrayValue: undefined,
+ *   }); // Returns ['class-1']
+ *
+ *   // Both provided - array takes precedence
+ *   normalizeSingularToArray({
+ *     singularValue: 'class-1',
+ *     arrayValue: ['class-2', 'class-3'],
+ *   }); // Returns ['class-2', 'class-3']
+ *
+ *   // Neither provided
+ *   normalizeSingularToArray({
+ *     singularValue: undefined,
+ *     arrayValue: undefined,
+ *   }); // Returns []
+ *   ```
+ */
+function normalizeSingularToArray(params) {
+    const { singularValue, arrayValue, deprecatedFieldName, replacementFieldName, context } = params;
+    // If array has values, use it (ignoring deprecated singular)
+    if (Array.isArray(arrayValue) && arrayValue.length > 0) {
+        return arrayValue;
+    }
+    // If singular value exists, convert to array and emit warning
+    // Also exclude empty strings to match original truthy-check behavior
+    if (singularValue !== undefined && singularValue !== null && singularValue !== '') {
+        if (deprecatedFieldName && replacementFieldName) {
+            emitDeprecationWarning({
+                deprecatedField: deprecatedFieldName,
+                replacementField: replacementFieldName,
+                deprecatedValue: singularValue,
+                context,
+            });
+        }
+        return [singularValue];
+    }
+    // Neither provided - return empty array
+    return [];
+}
+/**
+ * Normalize deprecated stock plan fields.
+ *
+ * Handles the OCF deprecation of `stock_class_id` (singular) → `stock_class_ids` (array).
+ *
+ * @param data - Stock plan data that may contain deprecated fields
+ * @param context - Optional context for deprecation warnings (e.g., "stockPlan.create")
+ * @returns Object containing normalized stock_class_ids and deprecation usage flag
+ *
+ * @example
+ *   ```typescript
+ *   // Old format (deprecated)
+ *   const result = normalizeDeprecatedStockPlanFields({
+ *     stock_class_id: 'sc-1',
+ *   });
+ *   // Returns { stock_class_ids: ['sc-1'], usedDeprecatedField: true }
+ *
+ *   // New format
+ *   const result = normalizeDeprecatedStockPlanFields({
+ *     stock_class_ids: ['sc-1', 'sc-2'],
+ *   });
+ *   // Returns { stock_class_ids: ['sc-1', 'sc-2'], usedDeprecatedField: false }
+ *   ```
+ */
+function normalizeDeprecatedStockPlanFields(data, context) {
+    // Also exclude empty strings to match original truthy-check behavior
+    const hasDeprecatedField = data.stock_class_id !== undefined && data.stock_class_id !== null && data.stock_class_id !== '';
+    const hasCurrentField = Array.isArray(data.stock_class_ids) && data.stock_class_ids.length > 0;
+    // Only count as using deprecated field if deprecated is present and current is not
+    const usedDeprecatedField = hasDeprecatedField && !hasCurrentField;
+    // Normalize null to undefined for the generic function, then filter results
+    const singularValue = data.stock_class_id ?? undefined;
+    const arrayValue = data.stock_class_ids ?? undefined;
+    const stock_class_ids = normalizeSingularToArray({
+        singularValue,
+        arrayValue,
+        deprecatedFieldName: 'stock_class_id',
+        replacementFieldName: 'stock_class_ids',
+        context: context ?? 'StockPlan',
+    });
+    return {
+        stock_class_ids,
+        usedDeprecatedField,
+    };
+}
+/**
+ * Check stock plan data for deprecated field usage without modifying the data.
+ *
+ * @param data - Stock plan data to check
+ * @returns Result indicating whether deprecated fields were used
+ *
+ * @example
+ *   ```typescript
+ *   const result = checkStockPlanDeprecatedFieldUsage({
+ *     stock_class_id: 'sc-1', // deprecated
+ *   });
+ *   // Returns { hasDeprecatedFields: true, deprecatedFieldsUsed: ['stock_class_id'] }
+ *   ```
+ */
+function checkStockPlanDeprecatedFieldUsage(data) {
+    const deprecatedFieldsUsed = [];
+    // Check for deprecated stock_class_id field (exclude empty strings to match original truthy-check behavior)
+    if (data.stock_class_id !== undefined && data.stock_class_id !== null && data.stock_class_id !== '') {
+        deprecatedFieldsUsed.push('stock_class_id');
+    }
+    return {
+        hasDeprecatedFields: deprecatedFieldsUsed.length > 0,
+        deprecatedFieldsUsed,
+    };
+}
+/**
+ * Known OCF deprecated field mappings.
+ * Add new deprecations here as they are discovered.
+ */
+exports.OCF_DEPRECATED_FIELDS = {
+    StockPlan: [
+        {
+            deprecatedField: 'stock_class_id',
+            replacementField: 'stock_class_ids',
+            deprecationType: 'singular_to_array',
+        },
+    ],
+};
+/**
+ * Get the list of deprecated field mappings for an OCF object type.
+ *
+ * @param objectType - The OCF object type name (e.g., 'StockPlan')
+ * @returns Array of deprecated field mappings for the object type
+ */
+function getDeprecatedFieldMappings(objectType) {
+    return exports.OCF_DEPRECATED_FIELDS[objectType] ?? [];
+}
+/**
+ * Check if a specific field is deprecated for an OCF object type.
+ *
+ * @param objectType - The OCF object type name
+ * @param fieldName - The field name to check
+ * @returns The deprecation mapping if the field is deprecated, undefined otherwise
+ */
+function getFieldDeprecation(objectType, fieldName) {
+    const mappings = getDeprecatedFieldMappings(objectType);
+    return mappings.find((m) => m.deprecatedField === fieldName);
+}
+/**
+ * Check an object for any deprecated field usage based on known deprecations.
+ *
+ * @param objectType - The OCF object type name
+ * @param data - The object data to check
+ * @returns Result indicating which deprecated fields were used
+ *
+ * @example
+ *   ```typescript
+ *   const result = checkDeprecatedFields('StockPlan', {
+ *     stock_class_id: 'sc-1', // deprecated
+ *     plan_name: 'Equity Plan',
+ *   });
+ *   // Returns { hasDeprecatedFields: true, deprecatedFieldsUsed: ['stock_class_id'] }
+ *   ```
+ */
+function checkDeprecatedFields(objectType, data) {
+    const mappings = getDeprecatedFieldMappings(objectType);
+    const deprecatedFieldsUsed = [];
+    for (const mapping of mappings) {
+        const value = data[mapping.deprecatedField];
+        // Also exclude empty strings to match original truthy-check behavior
+        if (value !== undefined && value !== null && value !== '') {
+            deprecatedFieldsUsed.push(mapping.deprecatedField);
+        }
+    }
+    return {
+        hasDeprecatedFields: deprecatedFieldsUsed.length > 0,
+        deprecatedFieldsUsed,
+    };
+}
+//# sourceMappingURL=deprecatedFieldNormalization.js.map

package/dist/utils/deprecatedFieldNormalization.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deprecatedFieldNormalization.js","sourceRoot":"","sources":["../../src/utils/deprecatedFieldNormalization.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;GAmBG;;;AA2CH,wDAeC;AAkDD,4DAwBC;AAmDD,gFA4BC;AA4BD,gFAYC;AAoCD,gEAEC;AASD,kDAGC;AAkBD,sDAgBC;AAlTD;;;GAGG;AACU,QAAA,wBAAwB,GAA6B;IAChE,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM;IACxC,OAAO,EAAE,SAAS;CACnB,CAAC;AAEF;;;;GAIG;AACH,SAAgB,sBAAsB,CAAC,OAA2B;IAChE,IAAI,CAAC,gCAAwB,CAAC,OAAO,EAAE,CAAC;QACtC,OAAO;IACT,CAAC;IAED,MAAM,OAAO,GACX,4BAA4B,OAAO,CAAC,eAAe,mBAAmB;QACtE,QAAQ,OAAO,CAAC,gBAAgB,aAAa,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAEvG,IAAI,gCAAwB,CAAC,OAAO,EAAE,CAAC;QACrC,gCAAwB,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;SAAM,CAAC;QACN,mHAAmH;QACnH,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACxB,CAAC;AACH,CAAC;AAoBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,SAAgB,wBAAwB,CAAI,MAAgC;IAC1E,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAEjG,6DAA6D;IAC7D,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,8DAA8D;IAC9D,qEAAqE;IACrE,IAAI,aAAa,KAAK,SAAS,IAAI,aAAa,KAAK,IAAI,IAAI,aAAa,KAAK,EAAE,EAAE,CAAC;QAClF,IAAI,mBAAmB,IAAI,oBAAoB,EAAE,CAAC;YAChD,sBAAsB,CAAC;gBACrB,eAAe,EAAE,mBAAmB;gBACpC,gBAAgB,EAAE,oBAAoB;gBACtC,eAAe,EAAE,aAAa;gBAC9B,OAAO;aACR,CAAC,CAAC;QACL,CAAC;QACD,OAAO,CAAC,aAAa,CAAC,CAAC;IACzB,CAAC;IAED,wCAAwC;IACxC,OAAO,EAAE,CAAC;AACZ,CAAC;AA2BD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,kCAAkC,CAChD,IAAsC,EACtC,OAAgB;IAEhB,qEAAqE;IACrE,MAAM,kBAAkB,GACtB,IAAI,CAAC,cAAc,KAAK,SAAS,IAAI,IAAI,CAAC,cAAc,KAAK,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,EAAE,CAAC;IAClG,MAAM,eAAe,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC;IAE/F,mFAAmF;IACnF,MAAM,mBAAmB,GAAG,kBAAkB,IAAI,CAAC,eAAe,CAAC;IAEnE,4EAA4E;IAC5E,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,IAAI,SAAS,CAAC;IACvD,MAAM,UAAU,GAAG,IAAI,CAAC,eAAe,IAAI,SAAS,CAAC;IAErD,MAAM,eAAe,GAAG,wBAAwB,CAAC;QAC/C,aAAa;QACb,UAAU;QACV,mBAAmB,EAAE,gBAAgB;QACrC,oBAAoB,EAAE,iBAAiB;QACvC,OAAO,EAAE,OAAO,IAAI,WAAW;KAChC,CAAC,CAAC;IAEH,OAAO;QACL,eAAe;QACf,mBAAmB;KACpB,CAAC;AACJ,CAAC;AAcD;;;;;;;;;;;;;GAaG;AACH,SAAgB,kCAAkC,CAAC,IAAsC;IACvF,MAAM,oBAAoB,GAAa,EAAE,CAAC;IAE1C,4GAA4G;IAC5G,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,IAAI,IAAI,CAAC,cAAc,KAAK,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,EAAE,EAAE,CAAC;QACpG,oBAAoB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC9C,CAAC;IAED,OAAO;QACL,mBAAmB,EAAE,oBAAoB,CAAC,MAAM,GAAG,CAAC;QACpD,oBAAoB;KACrB,CAAC;AACJ,CAAC;AAgBD;;;GAGG;AACU,QAAA,qBAAqB,GAA6C;IAC7E,SAAS,EAAE;QACT;YACE,eAAe,EAAE,gBAAgB;YACjC,gBAAgB,EAAE,iBAAiB;YACnC,eAAe,EAAE,mBAAmB;SACrC;KACF;CACF,CAAC;AAEF;;;;;GAKG;AACH,SAAgB,0BAA0B,CAAC,UAAkB;IAC3D,OAAO,6BAAqB,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;AACjD,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CAAC,UAAkB,EAAE,SAAiB;IACvE,MAAM,QAAQ,GAAG,0BAA0B,CAAC,UAAU,CAAC,CAAC;IACxD,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,qBAAqB,CAAC,UAAkB,EAAE,IAA6B;IACrF,MAAM,QAAQ,GAAG,0BAA0B,CAAC,UAAU,CAAC,CAAC;IACxD,MAAM,oBAAoB,GAAa,EAAE,CAAC;IAE1C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QAC5C,qEAAqE;QACrE,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;YAC1D,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IAED,OAAO;QACL,mBAAmB,EAAE,oBAAoB,CAAC,MAAM,GAAG,CAAC;QACpD,oBAAoB;KACrB,CAAC;AACJ,CAAC"}

package/dist/utils/index.d.ts

@@ -1,3 +1,4 @@
+export * from './deprecatedFieldNormalization';
 export * from './enumConversions';
 export * from './ocfComparison';
 export * from './ocfHelpers';

package/dist/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC"}

package/dist/utils/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./deprecatedFieldNormalization"), exports);
 __exportStar(require("./enumConversions"), exports);
 __exportStar(require("./ocfComparison"), exports);
 __exportStar(require("./ocfHelpers"), exports);

package/dist/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,kDAAgC;AAChC,+CAA6B;AAC7B,gDAA8B;AAC9B,uDAAqC;AACrC,oDAAkC;AAClC,+CAA6B;AAC7B,+CAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iEAA+C;AAC/C,oDAAkC;AAClC,kDAAgC;AAChC,+CAA6B;AAC7B,gDAA8B;AAC9B,uDAAqC;AACrC,oDAAkC;AAClC,+CAA6B;AAC7B,+CAA6B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-captable-protocol/canton",
-  "version": "0.2.178",
+  "version": "0.2.179",
   "description": "A TypeScript SDK for interacting with the Open CapTable Protocol (OCP) Factory contract on Canton blockchain",
   "license": "MIT",
   "main": "dist/index.js",