@contrail/flexplm 1.3.0-alpha.5 → 1.3.0

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

@@ -0,0 +1,124 @@
+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
+
+  publish-alpha:
+    name: Publish alpha
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.publish.outputs.version }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install and build
+        env:
+          NPM_TOKEN: ${{ secrets.ZACH_NPM_TOKEN_4 }}
+          NODE_AUTH_TOKEN: ${{ secrets.ZACH_NPM_TOKEN_4 }}
+        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
+          }
+        env:
+          NPM_TOKEN: ${{ secrets.ZACH_NPM_TOKEN_4 }}
+          NODE_AUTH_TOKEN: ${{ secrets.ZACH_NPM_TOKEN_4 }}
+
+  publish-release:
+    name: Publish release
+    if: github.event_name == 'push'
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.publish.outputs.version }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install and build
+        env:
+          NPM_TOKEN: ${{ secrets.ZACH_NPM_TOKEN_4 }}
+          NODE_AUTH_TOKEN: ${{ secrets.ZACH_NPM_TOKEN_4 }}
+        run: npm ci && npm run build
+
+      - name: Publish release
+        id: publish
+        run: |
+          npm publish
+          echo "version=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUT
+        env:
+          NPM_TOKEN: ${{ secrets.ZACH_NPM_TOKEN_4 }}
+          NODE_AUTH_TOKEN: ${{ secrets.ZACH_NPM_TOKEN_4 }}
+
+  verify-install:
+    name: Verify public install
+    needs: [publish-alpha, publish-release]
+    if: always() && (needs.publish-alpha.outputs.version || needs.publish-release.outputs.version)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install without auth
+        run: |
+          VERSION="${{ needs.publish-alpha.outputs.version || needs.publish-release.outputs.version }}"
+          echo "Verifying @contrail/flexplm@${VERSION} can be installed without auth..."
+          mkdir /tmp/install-test && cd /tmp/install-test
+          npm init -y > /dev/null
+          for attempt in 1 2 3; do
+            if npm install @contrail/flexplm@${VERSION} --no-save 2>/dev/null; then
+              echo "Install verified successfully."
+              exit 0
+            fi
+            echo "Attempt ${attempt} failed, waiting 10s for registry propagation..."
+            sleep 10
+          done
+          echo "::error::Failed to install @contrail/flexplm@${VERSION} after 3 attempts"
+          exit 1

package/CHANGELOG.md

@@ -7,7 +7,7 @@ Versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
-## [1.3.0] - 2026-04-12
+## [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.

package/lib/util/thumbnail-util.js

@@ -149,9 +149,12 @@ class ThumbnailUtil {
         return updatedEntity;
     }
     async createContentFromFlexPLM(thumbnailUrl, entityId, entityName) {
+        const urlParts = thumbnailUrl.split('/');
+        const fileName = urlParts[urlParts.length - 1] || 'thumbnail';
+        const encodedUrl = urlParts.map(part => encodeURIComponent(part)).join('/');
         const flexPLMConnect = new flexplm_connect_1.FlexPLMConnect(this.config);
         const response = await flexPLMConnect.getRequest({
-            urlPath: thumbnailUrl,
+            urlPath: encodedUrl,
             includeUrlContext: false,
             returnFullResponse: true,
         });
@@ -159,8 +162,6 @@ class ThumbnailUtil {
         const buffer = Buffer.from(fileBuffer);
         const contentTypeHeader = response.headers.get('content-type');
         const contentType = contentTypeHeader ? contentTypeHeader.split(';')[0] : 'application/octet-stream';
-        const urlParts = thumbnailUrl.split('/');
-        const fileName = urlParts[urlParts.length - 1] || 'thumbnail';
         const contentHolderReference = `${entityName}:${entityId}`;
         const content = await new sdk_1.Content().create({
             fileBuffer: buffer,

package/lib/util/thumbnail-util.spec.js

@@ -337,6 +337,46 @@ describe('ThumbnailUtil Tests', () => {
                 id: 'entity1',
             }));
         });
+        it('encodes URL path segments with special characters', async () => {
+            const mockResponse = {
+                arrayBuffer: jest.fn().mockResolvedValue(new ArrayBuffer(8)),
+                headers: { get: jest.fn().mockReturnValue('image/png') },
+            };
+            mockGetRequest.mockResolvedValue(mockResponse);
+            mockContentCreate.mockResolvedValue({
+                id: 'c1', contentType: 'image/png', fileName: 'my image.png',
+                primaryFileUrl: 'https://files/primary.png', largeViewableUrl: null,
+                mediumLargeViewableUrl: null, mediumViewableUrl: null, smallViewableUrl: null, tinyViewableUrl: null,
+            });
+            const event = { data: { [thumbnail_util_1.ThumbnailUtil.NEW_THUMBNAIL_ID]: '/rest/thumbnail/my image.png' } };
+            await tu.syncThumbnailToVibeIQ({ entityId: 'entity1', event, entityName: 'color' });
+            expect(mockGetRequest).toHaveBeenCalledWith({
+                urlPath: '/rest/thumbnail/my%20image.png',
+                includeUrlContext: false,
+                returnFullResponse: true,
+            });
+            expect(mockContentCreate).toHaveBeenCalledWith(expect.objectContaining({ fileName: 'my image.png' }));
+        });
+        it('encodes URL path segments with unicode characters', async () => {
+            const mockResponse = {
+                arrayBuffer: jest.fn().mockResolvedValue(new ArrayBuffer(8)),
+                headers: { get: jest.fn().mockReturnValue('image/jpeg') },
+            };
+            mockGetRequest.mockResolvedValue(mockResponse);
+            mockContentCreate.mockResolvedValue({
+                id: 'c2', contentType: 'image/jpeg', fileName: 'café-logo.jpg',
+                primaryFileUrl: 'https://files/primary.jpg', largeViewableUrl: null,
+                mediumLargeViewableUrl: null, mediumViewableUrl: null, smallViewableUrl: null, tinyViewableUrl: null,
+            });
+            const event = { data: { [thumbnail_util_1.ThumbnailUtil.NEW_THUMBNAIL_ID]: '/rest/thumbnail/café-logo.jpg' } };
+            await tu.syncThumbnailToVibeIQ({ entityId: 'entity1', event, entityName: 'item' });
+            expect(mockGetRequest).toHaveBeenCalledWith({
+                urlPath: '/rest/thumbnail/caf%C3%A9-logo.jpg',
+                includeUrlContext: false,
+                returnFullResponse: true,
+            });
+            expect(mockContentCreate).toHaveBeenCalledWith(expect.objectContaining({ fileName: 'café-logo.jpg' }));
+        });
         it('replaces content when primaryViewable.flexplmThumbnailUrl differs and updates entity', async () => {
             mockEntitiesGet.mockImplementation((opts) => {
                 if (opts.entityName === 'content-custom-size')

package/package.json

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

package/src/util/thumbnail-util.spec.ts

@@ -389,6 +389,56 @@ describe('ThumbnailUtil Tests', () =>{
       );
     });
 
+    it('encodes URL path segments with special characters', async () => {
+      const mockResponse = {
+        arrayBuffer: jest.fn().mockResolvedValue(new ArrayBuffer(8)),
+        headers: { get: jest.fn().mockReturnValue('image/png') },
+      };
+      mockGetRequest.mockResolvedValue(mockResponse);
+      mockContentCreate.mockResolvedValue({
+        id: 'c1', contentType: 'image/png', fileName: 'my image.png',
+        primaryFileUrl: 'https://files/primary.png', largeViewableUrl: null,
+        mediumLargeViewableUrl: null, mediumViewableUrl: null, smallViewableUrl: null, tinyViewableUrl: null,
+      });
+
+      const event = { data: { [ThumbnailUtil.NEW_THUMBNAIL_ID]: '/rest/thumbnail/my image.png' } };
+      await tu.syncThumbnailToVibeIQ({ entityId: 'entity1', event, entityName: 'color' });
+
+      expect(mockGetRequest).toHaveBeenCalledWith({
+        urlPath: '/rest/thumbnail/my%20image.png',
+        includeUrlContext: false,
+        returnFullResponse: true,
+      });
+      expect(mockContentCreate).toHaveBeenCalledWith(
+        expect.objectContaining({ fileName: 'my image.png' }),
+      );
+    });
+
+    it('encodes URL path segments with unicode characters', async () => {
+      const mockResponse = {
+        arrayBuffer: jest.fn().mockResolvedValue(new ArrayBuffer(8)),
+        headers: { get: jest.fn().mockReturnValue('image/jpeg') },
+      };
+      mockGetRequest.mockResolvedValue(mockResponse);
+      mockContentCreate.mockResolvedValue({
+        id: 'c2', contentType: 'image/jpeg', fileName: 'café-logo.jpg',
+        primaryFileUrl: 'https://files/primary.jpg', largeViewableUrl: null,
+        mediumLargeViewableUrl: null, mediumViewableUrl: null, smallViewableUrl: null, tinyViewableUrl: null,
+      });
+
+      const event = { data: { [ThumbnailUtil.NEW_THUMBNAIL_ID]: '/rest/thumbnail/café-logo.jpg' } };
+      await tu.syncThumbnailToVibeIQ({ entityId: 'entity1', event, entityName: 'item' });
+
+      expect(mockGetRequest).toHaveBeenCalledWith({
+        urlPath: '/rest/thumbnail/caf%C3%A9-logo.jpg',
+        includeUrlContext: false,
+        returnFullResponse: true,
+      });
+      expect(mockContentCreate).toHaveBeenCalledWith(
+        expect.objectContaining({ fileName: 'café-logo.jpg' }),
+      );
+    });
+
     it('replaces content when primaryViewable.flexplmThumbnailUrl differs and updates entity', async () => {
       mockEntitiesGet.mockImplementation((opts) => {
         if (opts.entityName === 'content-custom-size') return Promise.resolve([]);

package/src/util/thumbnail-util.ts

@@ -201,9 +201,13 @@ export class ThumbnailUtil {
   }
 
   private async createContentFromFlexPLM(thumbnailUrl: string, entityId: string, entityName: string): Promise<any> {
+    const urlParts = thumbnailUrl.split('/');
+    const fileName = urlParts[urlParts.length - 1] || 'thumbnail';
+
+    const encodedUrl = urlParts.map(part => encodeURIComponent(part)).join('/');
     const flexPLMConnect = new FlexPLMConnect(this.config);
     const response = await flexPLMConnect.getRequest({
-      urlPath: thumbnailUrl,
+      urlPath: encodedUrl,
       includeUrlContext: false,
       returnFullResponse: true,
     }) as Response;
@@ -213,9 +217,6 @@ export class ThumbnailUtil {
     const contentTypeHeader = response.headers.get('content-type');
     const contentType = contentTypeHeader ? contentTypeHeader.split(';')[0] : 'application/octet-stream';
 
-    const urlParts = thumbnailUrl.split('/');
-    const fileName = urlParts[urlParts.length - 1] || 'thumbnail';
-
     const contentHolderReference = `${entityName}:${entityId}`;
     const content = await new Content().create({
       fileBuffer: buffer,