@contrail/flexplm 1.7.2-alpha.f5ce754 → 1.7.3-alpha.2a95cdd

package/lib/interfaces/mapping-file.d.ts

@@ -776,6 +776,47 @@ interface MappingFileBase {
  *     },
  *   },
  * };
+ *
+ * @example
+ * // Multi-Entry and Composite FlexPLM properties.
+ * //
+ * // FlexPLM sends both shapes as a single string whose values are joined by
+ * // the separator '|~*~|' (a trailing separator follows the last value):
+ * //   Cuttable Width (multi-entry): '1MM Horizontal|~*~|2MM Vertical|~*~|'
+ * //   Content        (composite):   '50.0% MetalProcessing|~*~|50.0% Cable|~*~|'
+ * //
+ * // VibeIQ stores these raw '|~*~|'-joined strings as-is, so no split/join is
+ * // needed — a plain REKEY carries the value through unchanged in both
+ * // directions. If you later need to store an array or a cleaned display
+ * // value instead, add a VALUE_TRANSFORM task to `transformOrder` and a
+ * // matching `valueTransform` entry (see {@link DirectionalSection.valueTransform})
+ * // that splits on / joins with '|~*~|'.
+ * export const mapping: MappingFile = {
+ *   orgInfo: { appIdentifier: '@vibeiq/flexplm-connector', orgName: 'acme' },
+ *   typeConversion: { vibe2flex: {}, flex2vibe: {} },
+ *   LCSProduct: {
+ *     vibe2flex: {
+ *       transformOrder: [
+ *         { processor: 'REKEY', rekeyDelete: true, rekeyKeepEmptyValues: true, rekeyTransformersKey: 'rekey' },
+ *       ],
+ *       // flexField: 'vibeSlug' — raw '|~*~|' strings pass straight through.
+ *       rekey: {
+ *         cuttableWidth:   'cuttableWidth',    // multi-entry
+ *         materialContent: 'materialContent',  // composite (Flex 'Content')
+ *       },
+ *     },
+ *     flex2vibe: {
+ *       transformOrder: [
+ *         { processor: 'REKEY', rekeyDelete: true, rekeyKeepEmptyValues: true, rekeyTransformersKey: 'rekey' },
+ *       ],
+ *       // vibeSlug: 'flexField'
+ *       rekey: {
+ *         cuttableWidth:   'cuttableWidth',
+ *         materialContent: 'materialContent',
+ *       },
+ *     },
+ *   },
+ * };
  */
 export type MappingFile = MappingFileBase & {
     [mapKey: string]: MappingSection | MappingFileBase[keyof MappingFileBase];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/flexplm",
-  "version": "1.7.2-alpha.f5ce754",
+  "version": "1.7.3-alpha.2a95cdd",
   "description": "Library used for integration with flexplm.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",