@contrail/flexplm 1.3.0 → 1.3.1-alpha.585afc1

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

@@ -1,16 +1,74 @@
-export declare class TypeDefaults {
-    static NO_ENTITY_TYPE: string;
-    static NO_OBJECT_CLASS: string;
-    static NO_TYPE_PATH: string;
-    constructor();
-    static getDefaultObjectClass(entity: any): string;
-    static getDefaultObjectTypePath(entity: any): string;
-    static getDefaultIdentifierProperties(entity: any): string[];
-    static getDefaultInformationalProperties(entity: any): string[];
-    static getEntityType(entity: any): any;
-    static getDefaultEntityClass(object: any): string;
-    static getDefaultEntityTypePath(object: any): string;
-    static getDefaultIdentifierPropertiesFromObject(object: any): string[];
-    static getDefaultInformationalPropertiesFromObject(object: any): string[];
-    static getObjectClass(object: any): string;
-}
+export declare class TypeDefaults {
+    static NO_ENTITY_TYPE: string;
+    static NO_OBJECT_CLASS: string;
+    static NO_TYPE_PATH: string;
+    constructor();
+    /**Takes in full entity and returs the default FlexPLM
+     * object class.
+     *
+     * @param entity
+     * @returns string
+     */
+    static getDefaultObjectClass(entity: any): string;
+    /**Takes in full entity and returns the default FlexPLM type path
+     * object class.
+     *
+     * @param entity
+     * @returns string
+     */
+    static getDefaultObjectTypePath(entity: any): string;
+    /**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: any): string[];
+    /** 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: any): string[];
+    /** 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: any): any;
+    /**Takes in full object and returns the default VibeIQ
+   * entity class.
+   *
+   * @param entity
+   * @returns string
+   */
+    static getDefaultEntityClass(object: any): string;
+    /**Takes in full object and returns the default VibeIQ type path
+   * object class.
+   *
+   * @param object
+   * @returns string
+   */
+    static getDefaultEntityTypePath(object: any): string;
+    /**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: any): string[];
+    /** 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: any): string[];
+    static getObjectClass(object: any): string;
+}

package/lib/util/type-defaults.js

@@ -1,221 +1,279 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeDefaults = void 0;
-class TypeDefaults {
-    constructor() {
-    }
-    static getDefaultObjectClass(entity) {
-        const entityType = this.getEntityType(entity);
-        let objectClass = '';
-        if ('item' === entityType) {
-            if (entity.roles.includes('family')) {
-                objectClass = 'LCSProduct';
-            }
-            else if (entity.roles.includes('color')) {
-                objectClass = 'LCSSKU';
-            }
-        }
-        else if ('project-item' === entityType) {
-            if (entity.roles.includes('family')) {
-                objectClass = 'LCSProductSeasonLink';
-            }
-            else if (entity.roles.includes('color')) {
-                objectClass = 'LCSSKUSeasonLink';
-            }
-        }
-        else if ('color' === entityType) {
-            objectClass = 'LCSColor';
-        }
-        else if ('custom-entity' === entityType) {
-            objectClass = 'LCSRevisableEntity';
-        }
-        else if ('project' === entityType) {
-            objectClass = 'LCSSeason';
-        }
-        else if ('assortment' === entityType) {
-            if ('LCSSeason' === entity.flex2vibeMapKeyRoot || entity.publishToFlexPLM) {
-                objectClass = 'LCSSeason';
-            }
-            else {
-                objectClass = 'SeasonGroup';
-            }
-        }
-        return objectClass;
-    }
-    static getDefaultObjectTypePath(entity) {
-        let typePath = '';
-        const entityType = this.getEntityType(entity);
-        switch (entityType) {
-            case 'item':
-            case 'project-item':
-                typePath = 'Product';
-                break;
-            case 'color':
-                typePath = 'Color';
-                break;
-            case 'custom-entity':
-                typePath = 'Revisable Entity';
-                break;
-            case 'project':
-                typePath = 'Season';
-                break;
-            case 'assortment':
-                if ('LCSSeason' === entity.flex2vibeMapKeyRoot || entity.publishToFlexPLM) {
-                    typePath = 'Season';
-                }
-                else {
-                    typePath = 'Season Group';
-                }
-                break;
-        }
-        return typePath;
-    }
-    static getDefaultIdentifierProperties(entity) {
-        const identifierProps = [];
-        const entityType = this.getEntityType(entity);
-        switch (entityType) {
-            case 'item':
-                identifierProps.push('itemNumber');
-                break;
-            case 'project':
-                identifierProps.push('flexPLMSeasonName');
-                break;
-            case 'assortment':
-                if ('LCSSeason' === entity.flex2vibeMapKeyRoot || entity.publishToFlexPLM) {
-                    identifierProps.push('flexPLMSeasonName');
-                }
-                else {
-                    identifierProps.push('seasonGroupName');
-                }
-                break;
-            case 'color':
-            case 'custom-entity':
-                identifierProps.push('name');
-                break;
-        }
-        return identifierProps;
-    }
-    static getDefaultInformationalProperties(entity) {
-        const entityType = this.getEntityType(entity);
-        let properties = [];
-        if ('item' === entityType) {
-            if (entity.roles.includes('family')) {
-                properties.push('name');
-            }
-            else if (entity.roles.includes('color')) {
-                properties.push('optionName');
-            }
-        }
-        else if (['project', 'assortment'].includes(entityType)) {
-            properties.push('name');
-        }
-        return properties;
-    }
-    static getEntityType(entity) {
-        let entityType = entity['entityType'];
-        if (!entityType) {
-            const typePath = entity['typePath'];
-            if (typePath) {
-                const types = typePath.split(':');
-                if (types && types[0]) {
-                    entityType = types[0];
-                }
-            }
-        }
-        if (!entityType) {
-            throw Error(TypeDefaults.NO_ENTITY_TYPE);
-        }
-        return entityType;
-    }
-    static getDefaultEntityClass(object) {
-        let entityClass = '';
-        let objectClass = TypeDefaults.getObjectClass(object);
-        if (['LCSProduct', 'LCSSKU'].includes(objectClass)) {
-            entityClass = 'item';
-        }
-        else if (['LCSProductSeasonLink', 'LCSSKUSeasonLink'].includes(objectClass)) {
-            entityClass = 'project-item';
-        }
-        else if ('LCSColor' === objectClass) {
-            entityClass = 'color';
-        }
-        else if (['LCSSeason', 'SeasonGroup'].includes(objectClass)) {
-            entityClass = 'assortment';
-        }
-        else if (['LCSRevisableEntity', 'LCSLifecycleManaged', 'LCSLast', 'LCSMaterial'].includes(objectClass)) {
-            entityClass = 'custom-entity';
-        }
-        if (entityClass === '')
-            throw Error(TypeDefaults.NO_OBJECT_CLASS);
-        return entityClass;
-    }
-    static getDefaultEntityTypePath(object) {
-        let typePath = '';
-        const objectClass = TypeDefaults.getObjectClass(object);
-        switch (objectClass) {
-            case 'LCSProduct':
-            case 'LCSSKU':
-                typePath = 'item';
-                break;
-            case 'LCSProductSeasonLink':
-            case 'LCSSKUSeasonLink':
-                typePath = 'project-item';
-                break;
-            case 'LCSColor':
-                typePath = 'color';
-                break;
-            case 'LCSSeason':
-            case 'SeasonGroup':
-                typePath = 'assortment';
-                break;
-        }
-        if (typePath === '')
-            throw Error(TypeDefaults.NO_TYPE_PATH);
-        return typePath;
-    }
-    static getDefaultIdentifierPropertiesFromObject(object) {
-        const identifierProps = [];
-        const objectClass = TypeDefaults.getObjectClass(object);
-        switch (objectClass) {
-            case 'LCSProduct':
-            case 'LCSSKU':
-                identifierProps.push('itemNumber');
-                break;
-            case 'LCSSeason':
-                identifierProps.push('flexPLMSeasonName');
-                break;
-            case 'SeasonGroup':
-                identifierProps.push('seasonGroupName');
-                break;
-            case 'LCSColor':
-            case 'LCSRevisableEntity':
-            case 'LCSLifecycleManaged':
-            case 'LCSLast':
-            case 'LCSMaterial':
-                identifierProps.push('name');
-                break;
-        }
-        return identifierProps;
-    }
-    static getDefaultInformationalPropertiesFromObject(object) {
-        const objectClass = TypeDefaults.getObjectClass(object);
-        let properties = [];
-        if ('LCSProduct' === objectClass) {
-            properties.push('name');
-        }
-        else if ('LCSSKU' === objectClass) {
-            properties.push('optionName');
-        }
-        else if (['LCSSeason', 'SeasonGroup'].includes(objectClass)) {
-            properties.push('name');
-        }
-        return properties;
-    }
-    static getObjectClass(object) {
-        return (object) ? object['flexPLMObjectClass'] : '';
-    }
-}
-exports.TypeDefaults = TypeDefaults;
-TypeDefaults.NO_ENTITY_TYPE = 'Not able to determine the entity type of the entity object';
-TypeDefaults.NO_OBJECT_CLASS = 'Please ensure that the flexPLMObjectClass property is provided.';
-TypeDefaults.NO_TYPE_PATH = 'Please ensure that the flexPLMTypePath property is provided.';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeDefaults = void 0;
+class TypeDefaults {
+    constructor() {
+    }
+    /**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 = '';
+        if ('item' === entityType) {
+            if (entity.roles.includes('family')) {
+                objectClass = 'LCSProduct';
+            }
+            else if (entity.roles.includes('color')) {
+                objectClass = 'LCSSKU';
+            }
+        }
+        else if ('project-item' === entityType) {
+            if (entity.roles.includes('family')) {
+                objectClass = 'LCSProductSeasonLink';
+            }
+            else if (entity.roles.includes('color')) {
+                objectClass = 'LCSSKUSeasonLink';
+            }
+        }
+        else if ('color' === entityType) {
+            objectClass = 'LCSColor';
+        }
+        else if ('custom-entity' === entityType) {
+            objectClass = 'LCSRevisableEntity';
+        }
+        else if ('project' === entityType) {
+            objectClass = 'LCSSeason';
+        }
+        else if ('assortment' === entityType) {
+            if ('LCSSeason' === entity.flex2vibeMapKeyRoot || entity.publishToFlexPLM) {
+                objectClass = 'LCSSeason';
+            }
+            else {
+                objectClass = 'SeasonGroup';
+            }
+        }
+        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);
+        switch (entityType) {
+            case 'item':
+            case 'project-item':
+                typePath = 'Product';
+                break;
+            case 'color':
+                typePath = 'Color';
+                break;
+            case 'custom-entity':
+                typePath = 'Revisable Entity';
+                break;
+            case 'project':
+                typePath = 'Season';
+                break;
+            case 'assortment':
+                if ('LCSSeason' === entity.flex2vibeMapKeyRoot || entity.publishToFlexPLM) {
+                    typePath = 'Season';
+                }
+                else {
+                    typePath = 'Season Group';
+                }
+                break;
+        }
+        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);
+        switch (entityType) {
+            case 'item':
+                identifierProps.push('itemNumber');
+                break;
+            case 'project':
+                identifierProps.push('flexPLMSeasonName');
+                break;
+            case 'assortment':
+                if ('LCSSeason' === entity.flex2vibeMapKeyRoot || entity.publishToFlexPLM) {
+                    identifierProps.push('flexPLMSeasonName');
+                }
+                else {
+                    identifierProps.push('seasonGroupName');
+                }
+                break;
+            case 'color':
+            case 'custom-entity':
+                identifierProps.push('name');
+                break;
+        }
+        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 = [];
+        if ('item' === entityType) {
+            if (entity.roles.includes('family')) {
+                properties.push('name');
+            }
+            else if (entity.roles.includes('color')) {
+                properties.push('optionName');
+            }
+        }
+        else if (['project', 'assortment'].includes(entityType)) {
+            properties.push('name');
+        }
+        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) {
+            const typePath = entity['typePath'];
+            if (typePath) {
+                const types = typePath.split(':');
+                if (types && types[0]) {
+                    entityType = types[0];
+                }
+            }
+        }
+        if (!entityType) {
+            throw Error(TypeDefaults.NO_ENTITY_TYPE);
+        }
+        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);
+        if (['LCSProduct', 'LCSSKU'].includes(objectClass)) {
+            entityClass = 'item';
+        }
+        else if (['LCSProductSeasonLink', 'LCSSKUSeasonLink'].includes(objectClass)) {
+            entityClass = 'project-item';
+        }
+        else if ('LCSColor' === objectClass) {
+            entityClass = 'color';
+        }
+        else if (['LCSSeason', 'SeasonGroup'].includes(objectClass)) {
+            entityClass = 'assortment';
+        }
+        else if (['LCSRevisableEntity', 'LCSLifecycleManaged', 'LCSLast', 'LCSMaterial'].includes(objectClass)) {
+            entityClass = 'custom-entity';
+        }
+        if (entityClass === '')
+            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);
+        switch (objectClass) {
+            case 'LCSProduct':
+            case 'LCSSKU':
+                typePath = 'item';
+                break;
+            case 'LCSProductSeasonLink':
+            case 'LCSSKUSeasonLink':
+                typePath = 'project-item';
+                break;
+            case 'LCSColor':
+                typePath = 'color';
+                break;
+            case 'LCSSeason':
+            case 'SeasonGroup':
+                typePath = 'assortment';
+                break;
+        }
+        if (typePath === '')
+            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);
+        switch (objectClass) {
+            case 'LCSProduct':
+            case 'LCSSKU':
+                identifierProps.push('itemNumber');
+                break;
+            case 'LCSSeason':
+                identifierProps.push('flexPLMSeasonName');
+                break;
+            case 'SeasonGroup':
+                identifierProps.push('seasonGroupName');
+                break;
+            case 'LCSColor':
+            case 'LCSRevisableEntity':
+            case 'LCSLifecycleManaged':
+            case 'LCSLast':
+            case 'LCSMaterial':
+                identifierProps.push('name');
+                break;
+        }
+        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 = [];
+        if ('LCSProduct' === objectClass) {
+            properties.push('name');
+        }
+        else if ('LCSSKU' === objectClass) {
+            properties.push('optionName');
+        }
+        else if (['LCSSeason', 'SeasonGroup'].includes(objectClass)) {
+            properties.push('name');
+        }
+        return properties;
+    }
+    static getObjectClass(object) {
+        return (object) ? object['flexPLMObjectClass'] : '';
+    }
+}
+exports.TypeDefaults = TypeDefaults;
+TypeDefaults.NO_ENTITY_TYPE = 'Not able to determine the entity type of the entity object';
+TypeDefaults.NO_OBJECT_CLASS = 'Please ensure that the flexPLMObjectClass property is provided.';
+TypeDefaults.NO_TYPE_PATH = 'Please ensure that the flexPLMTypePath property is provided.';

package/lib/util/type-defaults.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};