@contrail/flexplm 1.5.1-alpha.c9b11be → 1.6.0-alpha.6f15d4e

package/lib/util/type-defaults.js

@@ -4,12 +4,26 @@ exports.TypeDefaults = void 0;
 class TypeDefaults {
     constructor() {
     }
+    /** Applies values from the resolved config to TypeDefaults static state.
+     *  Currently toggles whether LCSMaterial is treated as an item (new) or a
+     *  custom-entity (old) based on config.LCSMaterial.processAsItem.
+     *  Technically this could cause side effects if different parts of the code
+     *  expect different behavior, but in practice * @param config will be
+     *  consistent across the app and this is simpler than passing this config
+     *  through multiple layers of function calls.
+     */
     static applyConfig(config) {
         TypeDefaults.processLCSMaterialAsItem = TypeDefaults.isPropertyTrue(config?.LCSMaterial?.processAsItem);
     }
     static isPropertyTrue(value) {
         return value === true || (typeof value === 'string' && value.toLowerCase() === 'true');
     }
+    /**Takes in full entity and returs the default FlexPLM
+     * object class.
+     *
+     * @param entity
+     * @returns string
+     */
     static getDefaultObjectClass(entity) {
         const entityType = this.getEntityType(entity);
         let objectClass = '';
@@ -48,6 +62,12 @@ class TypeDefaults {
         }
         return objectClass;
     }
+    /**Takes in full entity and returns the default FlexPLM type path
+     * object class.
+     *
+     * @param entity
+     * @returns string
+     */
     static getDefaultObjectTypePath(entity) {
         let typePath = '';
         const entityType = this.getEntityType(entity);
@@ -76,6 +96,13 @@ class TypeDefaults {
         }
         return typePath;
     }
+    /**Takes in full entity and returns the slugs for the default identifier
+     *  properties. These properties are used when searching for an entity
+     * object class.
+     *
+     * @param entity
+     * @returns string[]
+     */
     static getDefaultIdentifierProperties(entity) {
         const identifierProps = [];
         const entityType = this.getEntityType(entity);
@@ -101,6 +128,13 @@ class TypeDefaults {
         }
         return identifierProps;
     }
+    /** Takes in full entity and returns the slugs for informational
+     * properties.  These properties are helpful when debugging issues
+     * where the identifier properties don't find a match.
+     *
+     * @param entity
+     * @returns string[]
+     */
     static getDefaultInformationalProperties(entity) {
         const entityType = this.getEntityType(entity);
         let properties = [];
@@ -117,6 +151,12 @@ class TypeDefaults {
         }
         return properties;
     }
+    /** Returns the VibeIQ entity type from an entity.
+     * Throws error if it can't determine the entity type
+     *
+     * @param entity
+     * @returns string
+     */
     static getEntityType(entity) {
         let entityType = entity['entityType'];
         if (!entityType) {
@@ -133,6 +173,12 @@ class TypeDefaults {
         }
         return entityType;
     }
+    /**Takes in full object and returns the default VibeIQ
+   * entity class.
+   *
+   * @param entity
+   * @returns string
+   */
     static getDefaultEntityClass(object) {
         let entityClass = '';
         let objectClass = TypeDefaults.getObjectClass(object);
@@ -161,6 +207,12 @@ class TypeDefaults {
             throw Error(TypeDefaults.NO_OBJECT_CLASS);
         return entityClass;
     }
+    /**Takes in full object and returns the default VibeIQ type path
+   * object class.
+   *
+   * @param object
+   * @returns string
+   */
     static getDefaultEntityTypePath(object) {
         let typePath = '';
         const objectClass = TypeDefaults.getObjectClass(object);
@@ -190,6 +242,13 @@ class TypeDefaults {
             throw Error(TypeDefaults.NO_TYPE_PATH);
         return typePath;
     }
+    /**Takes in full entity and returns the slugs for the default identifier
+ *  properties. These properties are used when searching for an entity
+ * object class.
+ *
+ * @param entity
+ * @returns string[]
+ */
     static getDefaultIdentifierPropertiesFromObject(object) {
         const identifierProps = [];
         const objectClass = TypeDefaults.getObjectClass(object);
@@ -221,6 +280,13 @@ class TypeDefaults {
         }
         return identifierProps;
     }
+    /** Takes in full object and returns the slugs for informational
+   * properties.  These properties are helpful when debugging issues
+   * where the identifier properties don't find a match.
+   *
+   * @param object
+   * @returns string[]
+   */
     static getDefaultInformationalPropertiesFromObject(object) {
         const objectClass = TypeDefaults.getObjectClass(object);
         let properties = [];

package/lib/util/type-defaults.spec.js

@@ -304,7 +304,7 @@ describe('Type Defaults', () => {
             expect(() => type_defaults_1.TypeDefaults.getEntityType(entity)).toThrowError();
             expect(() => type_defaults_1.TypeDefaults.getEntityType(entity)).toThrow(type_defaults_1.TypeDefaults.NO_ENTITY_TYPE);
         });
-    });
+    }); //getEntityType
     describe('getDefaultEntityClass', () => {
         it('item - LCSProduct', () => {
             const object = {
@@ -389,7 +389,7 @@ describe('Type Defaults', () => {
             const entityClass = type_defaults_1.TypeDefaults.getDefaultEntityClass(object);
             expect(entityClass).toBe('custom-entity');
         });
-    });
+    }); //getDefaultEntityClass
     describe('getDefaultEntityTypePath', () => {
         it('LCSProduct', () => {
             const object = {
@@ -459,7 +459,7 @@ describe('Type Defaults', () => {
             };
             expect(() => type_defaults_1.TypeDefaults.getDefaultEntityTypePath(object)).toThrowError(type_defaults_1.TypeDefaults.NO_TYPE_PATH);
         });
-    });
+    }); //getDefaultEntityTypePath
     describe('getDefaultIdentifierPropertiesFromObject', () => {
         it('LCSProduct', () => {
             const object = {
@@ -539,7 +539,7 @@ describe('Type Defaults', () => {
             expect(defaultIdentifiers).toContain('name');
             expect(defaultIdentifiers).toHaveLength(1);
         });
-    });
+    }); //getDefaultIdentifierPropertiesFromObject
     describe('getDefaultInformationalPropertiesFromObject', () => {
         it('LCSProduct', () => {
             const object = {
@@ -594,7 +594,7 @@ describe('Type Defaults', () => {
             const defaultIdentifiers = type_defaults_1.TypeDefaults.getDefaultInformationalPropertiesFromObject(object);
             expect(defaultIdentifiers).toHaveLength(0);
         });
-    });
+    }); //getDefaultInformationalPropertiesFromObject
     describe('applyConfig', () => {
         afterEach(() => {
             type_defaults_1.TypeDefaults.applyConfig({});

package/lib/util/type-utils.d.ts

@@ -5,9 +5,30 @@ export declare class TypeUtils {
     constructor();
     getTypeById(id: any): Promise<import("@contrail/types").Type>;
     getByRootAndPath(options: TypeClientOptions): Promise<import("@contrail/types").Type>;
+    /** Deprecated: use TypeConversionUtils.getObjectTypePath() */
     static getFlexPLMTypePath(entity: any): any;
+    /**  Deprecated: use TypeConversionUtils.getObjectClass()
+     *
+     * @param entityType
+     * @param newData
+     * @returns
+     */
     getEventObjectClass(entityType: string, newData: any): string;
+    /** Gets the VibeIQ entity type for the object data
+     * @param data: object data
+     */
     getEntityTypeClientOptionsUsingMapping(transformMapFile: any, mapFileUtil: any, data: any): Promise<TypeClientOptions>;
+    /** Gets the VibeIQ entity type for the object data
+     * @param objectClass: string object class
+     * @param data: object data
+     */
     getEntityTypeClientOptions(objectClass: string, data: any): TypeClientOptions;
+    /** This will filter the properties based the newData entity.
+     * It is assumed the type is correct for the entity
+     *
+     * @param type entire type object
+     * @param newData the entity being processed
+     * @returns TypeProperty[] of applicable properties
+     */
     filterTypeProperties(type: any, newData: any): TypeProperty[];
 }

package/lib/util/type-utils.js

@@ -9,6 +9,7 @@ class TypeUtils {
         this.typesObj = new sdk_1.Types();
     }
     async getTypeById(id) {
+        // this.logger.log('!-getTypeById: ' + id);
         const type = await this.typesObj.getType({
             id,
             relations: ['typeProperties', 'typeInterfaces']
@@ -19,9 +20,16 @@ class TypeUtils {
         const type = await this.typesObj.getByRootAndPath(options);
         return type;
     }
+    /** Deprecated: use TypeConversionUtils.getObjectTypePath() */
     static getFlexPLMTypePath(entity) {
         return entity['flexPLMTypePath'] || entity['flexTypePath'] || '';
     }
+    /**  Deprecated: use TypeConversionUtils.getObjectClass()
+     *
+     * @param entityType
+     * @param newData
+     * @returns
+     */
     getEventObjectClass(entityType, newData) {
         let objectClass = '';
         if ('item' === entityType) {
@@ -48,6 +56,9 @@ class TypeUtils {
         }
         return objectClass;
     }
+    /** Gets the VibeIQ entity type for the object data
+     * @param data: object data
+     */
     async getEntityTypeClientOptionsUsingMapping(transformMapFile, mapFileUtil, data) {
         const root = await type_conversion_utils_1.TypeConversionUtils.getEntityClassFromObject(transformMapFile, mapFileUtil, data);
         const path = await type_conversion_utils_1.TypeConversionUtils.getEntityTypePathFromOjbect(transformMapFile, mapFileUtil, data);
@@ -57,6 +68,10 @@ class TypeUtils {
         };
         return tco;
     }
+    /** Gets the VibeIQ entity type for the object data
+     * @param objectClass: string object class
+     * @param data: object data
+     */
     getEntityTypeClientOptions(objectClass, data) {
         let tco;
         if (['LCSProduct', 'LCSSKU'].includes(objectClass)) {
@@ -75,6 +90,7 @@ class TypeUtils {
             };
         }
         else if (['LCSBusinessObject', 'LCSRevisableEntity', 'LCSLast'].includes(objectClass)) {
+            //TODO need to write logic using mapping file
             tco = {
                 root: 'custom-entity'
             };
@@ -82,6 +98,13 @@ class TypeUtils {
         }
         return tco;
     }
+    /** This will filter the properties based the newData entity.
+     * It is assumed the type is correct for the entity
+     *
+     * @param type entire type object
+     * @param newData the entity being processed
+     * @returns TypeProperty[] of applicable properties
+     */
     filterTypeProperties(type, newData) {
         let filteredProps = type['typeProperties'];
         const typePath = type['typePath'];

package/lib/util/type-utils.spec.js

@@ -103,6 +103,7 @@ describe('filterProperties-item', () => {
         expect(filteredProps.length).toEqual(len);
     });
 });
+//project-item
 describe('filterProperties-project-item', () => {
     const projectItemType = {
         typePath: 'project-item'
@@ -152,6 +153,7 @@ describe('filterProperties-project-item', () => {
         expect(filteredProps.length).toEqual(len);
     });
 });
+//color
 describe('filterProperties-color', () => {
     const colorType = {
         typePath: 'color'

package/package.json

@@ -1,11 +1,18 @@
 {
   "name": "@contrail/flexplm",
-  "version": "1.5.1-alpha.c9b11be",
+  "version": "1.6.0-alpha.6f15d4e",
   "description": "Library used for integration with flexplm.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
+  "bin": {
+    "flexplm-mapping": "lib/cli/index.js"
+  },
+  "files": [
+    "lib/**/*",
+    "scripts/copy-template.js"
+  ],
   "scripts": {
-    "build": "tsc",
+    "build": "tsc && node scripts/copy-template.js",
     "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
     "lint": "tslint -p tsconfig.json",
     "test": "jest",
@@ -25,6 +32,14 @@
     "tslint-config-prettier": "^1.18.0",
     "typescript": "^4.0.0"
   },
+  "peerDependencies": {
+    "typescript": ">=4.0.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
   "jest": {
     "moduleFileExtensions": [
       "js",
@@ -40,10 +55,10 @@
     "testEnvironment": "node"
   },
   "dependencies": {
-    "@contrail/app-framework": "^1.3.4",
-    "@contrail/sdk": "^1.4.3",
-    "@contrail/transform-data": "^1.1.3",
-    "@contrail/util": "^1.0.48",
+    "@contrail/app-framework": "^1.4.3",
+    "@contrail/sdk": "^1.5.10",
+    "@contrail/transform-data": "^1.3.2",
+    "@contrail/util": "^1.3.1",
     "axios": "^1.4.0",
     "p-limit": "^3.1.0"
   }

package/scripts/copy-template.js

@@ -0,0 +1,10 @@
+'use strict';
+const fs = require('fs');
+const path = require('path');
+
+const SRC = path.join('src', 'cli', 'template', 'mapping-template.ts.template');
+const DST = path.join('lib', 'cli', 'template', 'mapping-template.ts.template');
+
+fs.mkdirSync(path.dirname(DST), { recursive: true });
+fs.copyFileSync(SRC, DST);
+console.log(`Copied ${SRC} -> ${DST}`);

package/.github/pull_request_template.md

@@ -1,31 +0,0 @@
-## What
-- [ ] Bugfix
-- [ ] Feature
-- [ ] Enhancement
-
-Description: 
-<!--
-Describe the functional changes of the PR.
-
-If the mechanism of your change are complex, describe them in detail as you
-would if you were explaining them to a team mate.
-
-If the PR is simple, there is no need to repeat yourself. A small description
-is sufficient.
--->
-
-## Why
-<!-- 
-why is this change needed? Same rules as with #What
- -->
-
-
-## Testing added
-<!-- 
-Describe the testing you added to this PR
- -->
-
-
-## Link to Jira ticket(s)
-https://vibe-team.atlassian.net/browse/VIBE-TICKET_NUMBER_HERE
-

package/.github/workflows/flexplm-lib.yml

@@ -1,27 +0,0 @@
-name: flexplm-lib-tests
-on:
-  pull_request:
-  workflow_dispatch: # allow running in github actions manually
-jobs:
-  test:
-    runs-on: ubuntu-24.04
-    strategy:
-      matrix:
-        node-version: [22.14.0, 24]
-    steps:
-      - name: Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      - uses: actions/checkout@v3
-
-      - name: NPM Install
-        env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npm ci
-
-      - name: Unit Tests -
-        env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npm test

package/.github/workflows/publish-to-npm.yml

@@ -1,121 +0,0 @@
-name: Publish to NPM
-
-on:
-  push:
-    branches: [master]
-    paths-ignore:
-      - '.github/**'
-  pull_request:
-    branches: [master]
-    paths-ignore:
-      - '.github/**'
-
-jobs:
-  check-version:
-    name: Verify version is available on npm
-    if: github.event_name == 'pull_request'
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Check version not already published
-        run: |
-          PACKAGE_NAME=$(node -p "require('./package.json').name")
-          VERSION=$(node -p "require('./package.json').version")
-          echo "Checking if ${PACKAGE_NAME}@${VERSION} exists on npm..."
-          if npm view "${PACKAGE_NAME}@${VERSION}" version 2>/dev/null; then
-            echo "::error::Version ${VERSION} is already published on npm. Bump the version in package.json before merging."
-            exit 1
-          else
-            echo "Version ${VERSION} is available."
-          fi
-
-  check-dependencies:
-    name: Verify no private dependencies
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Verify no private dependencies
-        run: |
-          node -e "
-            const deps = require('./package.json').dependencies || {};
-            const { execSync } = require('child_process');
-            let failed = false;
-            for (const pkg of Object.keys(deps)) {
-              try {
-                execSync('npm view ' + pkg, { stdio: 'pipe' });
-              } catch {
-                console.error('::error::Dependency ' + pkg + ' is not publicly accessible on npm');
-                failed = true;
-              }
-            }
-            if (failed) process.exit(1);
-            console.log('All ' + Object.keys(deps).length + ' dependencies are public.');
-          "
-
-  publish-alpha:
-    name: Publish alpha
-    needs: check-dependencies
-    if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository
-    runs-on: ubuntu-latest
-    permissions:
-      id-token: write
-      contents: read
-    outputs:
-      version: ${{ steps.publish.outputs.version }}
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version: '24'
-          registry-url: 'https://registry.npmjs.org'
-
-      - name: Install and build
-        run: npm ci && npm run build
-
-      - name: Publish alpha
-        id: publish
-        run: |
-          SHORT_SHA=$(echo ${{ github.event.pull_request.head.sha }} | cut -c1-7)
-          VERSION=$(node -p "require('./package.json').version")-alpha.${SHORT_SHA}
-          npm version $VERSION --no-git-tag-version
-          OUTPUT=$(npm publish --tag alpha 2>&1) && {
-            echo "version=$VERSION" >> $GITHUB_OUTPUT
-          } || {
-            if echo "$OUTPUT" | grep -q "You cannot publish over the previously published versions"; then
-              echo "::warning::Alpha ${VERSION} already published, skipping."
-            else
-              echo "::error::Failed to publish alpha ${VERSION}"
-              echo "$OUTPUT"
-              exit 1
-            fi
-          }
-
-  publish-release:
-    name: Publish release
-    needs: check-dependencies
-    if: github.event_name == 'push'
-    runs-on: ubuntu-latest
-    permissions:
-      id-token: write
-      contents: read
-    outputs:
-      version: ${{ steps.publish.outputs.version }}
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version: '24'
-          registry-url: 'https://registry.npmjs.org'
-
-      - name: Install and build
-        run: npm ci && npm run build
-
-      - name: Publish release
-        id: publish
-        run: |
-          npm publish
-          echo "version=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUT

package/CHANGELOG.md

@@ -1,49 +0,0 @@
-# Changelog
-
-All notable changes to `@contrail/flexplm` are documented here.
-
-Format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
-Versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-## [1.5.1] - 2026-05-14
-### Added
-- Added sending an external event with the publish payload and trigger key of `VibeIQ|AssortmentPublishedToFlexPLM` to enable secondary events to run on the event / data which was generated.  Also includes the payload in the data which can be passed to the next action.
-
-## [1.5.0] - 2026-05-12
-### Added
-- Added support for Inbound `LCSMaterial` to sync to the entity class `item` with type path `item:material` and `itemNumber` as identifier.  This is controlled by an `LCSMaterial.processAsItem` (default `false`) config default.
-- Added optional identity-service lookup in `DataConverter.setObjectReferenceValue` for resolving inbound `object_reference` values. Enabled per referenced entity type via `config.search.<entityType>.useIdentityServiceForInboundData`. When enabled the reference is resolved via the identity service using a uniqueness pool key; otherwise behavior falls through to the existing `getAllObjectReferences` query path.
-
-## [1.4.0] - 2026-05-06
-### Added
-- Added `getEntityUsingIdentityService` method to `BaseEntityProcessor` for looking up entities via the identity service using a pool key and property criteria. Returns the resolved entity from the identity's `entityReference`, `undefined` if not found, or throws if multiple matches exist.
-
-## [1.3.2] - 2026-05-01
-### Added
-- Added syncing Size Range properties; they sync as the raw VibeIQ data. For Example: { "sizes": { "30": ["30","32"], "32": ["30","32"]}, "dimension1": {"slug": "width","label": "Width"}, "dimension2": {"slug": "length", "label": "Length"}}
-
-## [1.3.0] - 2026-04-15
-### Added
-- Added inbound thumbnail/primary content syncing from FlexPLM to VibeIQ via `ThumbnailUtil.syncThumbnailToVibeIQ`.
-- Added `syncInboundImages` and `syncOutboundImages` methods to `TypeConversionUtils` for controlling image sync per map file configuration.
-- Added `PRIMARY_CONTENT_UPDATED` status to `EventShortMessageStatus` for when only primary content changes are detected.
-
-### Changed
-- `BaseEntityProcessor` update flow now distinguishes between primary-content-only changes and no changes, returning the updated entity when only the thumbnail was synced.
-- Improved `FlexPLMConnect.getRequest` function and added unit tests.
-
-## [1.2.1] - 2026-04-08
-
-### Added
-- Added EventShortMessageStatus status values for adding items to projects functionality.
-- Added `TypeConversionUtils.isOutboundCreatableFromEntity` method to determine if VibeIQ entities are creatable in FlexPLM (defaults to true).
-
-### Changed
-- Added optional `context` parameter to `TypeConversionUtils.isInboundCreatableFromObject` method to allow passing context data to map file `isInboundCreatable` functions.
-
-## [1.1.66] - (initial changelog entry)
-
-- Initial changelog. Prior releases did not include a changelog.
-  See git history for changes predating this entry.

package/publish.bat

@@ -1,5 +0,0 @@
-rd /s /q lib
-call npm install
-call npm run build
-call npm version patch
-call npm publish

package/publish.sh

@@ -1,5 +0,0 @@
-rm -rf lib;
-npm install;
-npm run build;
-npm version patch;
-npm publish;