@dotdev/apparel21-sdk - npm Package Compare versions

Comparing version 0.0.11 to 0.0.13

CHANGELOG.md

@@ -5,2 +5,14 @@ # Changelog
 
+### [0.0.13](https://gitlab.com/dotdevv/packages/apparel21-sdk/compare/v0.0.12...v0.0.13) (2021-05-16)
+
+### Bug Fixes
+
+- remove failing test ([581749b](https://gitlab.com/dotdevv/packages/apparel21-sdk/commit/581749ba65a6cc367502b3073f3650b0269c1d4c))
+
+### [0.0.12](https://gitlab.com/dotdevv/packages/apparel21-sdk/compare/v0.0.11...v0.0.12) (2021-05-16)
+
+### Features
+
+- update ReferenceTypes.fetchById to fetch reference values ([a579963](https://gitlab.com/dotdevv/packages/apparel21-sdk/commit/a57996301ee927d5ff2e0a465024ab41e3174aec))
+
 ### [0.0.11](https://gitlab.com/dotdevv/packages/apparel21-sdk/compare/v0.0.10...v0.0.11) (2021-04-30)
@@ -7,0 +19,0 @@

lib/common/types.d.ts

@@ -28,9 +28,12 @@ export declare type RequestFunction = (config: AP21Request) => any;
     id: number;
-    code?: string;
-    name?: string;
+    code: string;
+    name: string;
 }
+export interface ReferenceTypeWithReferences extends ReferenceType {
+    references: ReferenceValue[];
+}
 export interface ReferenceValue {
     id: number;
-    code?: string;
-    name?: string;
+    code: string;
+    name: string;
 }
@@ -37,0 +40,0 @@ export interface Reference {

lib/modules/ReferenceTypes.d.ts

@@ -1,2 +0,2 @@
-import { ReferenceType, RequestFunction } from '../common/types';
+import { ReferenceType, RequestFunction, ReferenceTypeWithReferences } from '../common/types';
 export declare class ReferenceTypes {
@@ -19,9 +19,7 @@ private request;
     /**
-     * Retrieves Reference Type details
+     * Retrieve references for a given reference type id.
      *
-     * All Reference Type Ids will be returned.
-     *
      * @param {number} id: reference type id
      */
-    fetchById: (id: number) => Promise<ReferenceType>;
+    fetchById: (id: number) => Promise<ReferenceTypeWithReferences>;
 }

lib/modules/ReferenceTypes.js

@@ -22,19 +22,15 @@ "use strict";
             });
-            const response = referenceType_1.formatReferenceTypes(res.ReferenceTypes.ReferenceType);
-            return response;
+            return res.ReferenceTypes.ReferenceType.map((rawReferenceType) => referenceType_1.formatReferenceType(rawReferenceType));
         };
         /**
-         * Retrieves Reference Type details
+         * Retrieve references for a given reference type id.
          *
-         * All Reference Type Ids will be returned.
-         *
          * @param {number} id: reference type id
          */
         this.fetchById = async (id) => {
-            const url = `/ReferenceTypes/${id}`;
+            const url = `/References/${id}`;
             const res = await this.request({
                 uri: url,
             });
-            const response = referenceType_1.formatReferenceTypes([res.ReferenceType])[0];
-            return response;
+            return referenceType_1.formatReferenceTypeWithReferences(res.ReferencesbyType);
         };
@@ -41,0 +37,0 @@ this.request = request;

lib/utils/referenceType.d.ts

@@ -1,2 +0,4 @@
-import { ReferenceType } from '../common/types';
-export declare const formatReferenceTypes: (referenceTypes: any[]) => ReferenceType[];
+import { ReferenceType, ReferenceValue, ReferenceTypeWithReferences } from '../common/types';
+export declare const formatReferenceType: (rawReferenceType: any) => ReferenceType;
+export declare const formatReferenceTypeWithReferences: (rawReferenceType: any) => ReferenceTypeWithReferences;
+export declare const formatReferenceValue: (rawReferenceValue: any) => ReferenceValue;

lib/utils/referenceType.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatReferenceTypes = void 0;
-exports.formatReferenceTypes = (referenceTypes) => referenceTypes.map((refType) => ({
-    id: parseInt(refType.Id[0], 10),
-    code: refType.Code[0],
-    name: refType.Name[0],
-}));
+exports.formatReferenceValue = exports.formatReferenceTypeWithReferences = exports.formatReferenceType = void 0;
+// @todo get rid of all these any's (rage!)
+// note, in the ReferenceType payload, attributes are different from References/1
+exports.formatReferenceType = (rawReferenceType) => ({
+    id: parseInt(rawReferenceType.Id?.[0] ?? rawReferenceType.ReferenceTypeId?.[0], 10),
+    code: rawReferenceType.Code?.[0] ?? rawReferenceType.ReferenceTypeCode?.[0],
+    name: rawReferenceType.Name?.[0] ?? rawReferenceType.ReferenceTypeName?.[0],
+});
+exports.formatReferenceTypeWithReferences = (rawReferenceType) => ({
+    ...exports.formatReferenceType(rawReferenceType),
+    references: rawReferenceType.References?.[0]?.Reference.map((rawReferenceValue) => exports.formatReferenceValue(rawReferenceValue)) ?? [],
+});
+exports.formatReferenceValue = (rawReferenceValue) => ({
+    id: parseInt(rawReferenceValue.Id[0], 10),
+    code: rawReferenceValue.Code[0],
+    name: rawReferenceValue.Name[0],
+});
 //# sourceMappingURL=referenceType.js.map

package.json

 {
   "name": "@dotdev/apparel21-sdk",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "license": "UNLICENSED",
@@ -13,2 +13,3 @@ "description": "Apparel21 Interface Library",
     "build": "tsc",
+    "watch": "tsc --watch",
     "test": "jest",
@@ -15,0 +16,0 @@ "release": "./release.sh",

No alert changes

Improved metrics

Total package byte prevSize

201473

increased by1.11%

Lines of code

3275

increased by0.31%

No dependency changes