Package Updates (#150)

Author: labkey-nicka

CHANGELOG.md

@@ -1,5 +1,12 @@
+## 1.19.0 - 2023-03-22
+- Package updates
+- Extract jest configuration out of `package.json` and into `jest.config.js`.
+- Add typings for `ResponseMetadata` and `MetadataField` for query response.
+- Replace `[[Reference]]` syntax in docs with `{@link Reference}`.
+- Export additional types so they're not hidden from implementors.
+
 ## 1.18.8 - 2023-03-02
-- Issue 47202: Options to reduce payload of getContainers.api response
+- [Issue 47202](https://www.labkey.org/home/Developer/issues/issues-details.view?issueId=47202): Options to reduce payload of getContainers.api response
   - two new properties: includeWorkbookChildren and includeStandardProperties 
 
 ## 1.18.7 - 2023-02-28

jest.config.js

@@ -0,0 +1,23 @@
+module.exports = {
+    globals: {
+        LABKEY: {
+            contextPath: '',
+            defaultHeaders: {
+                'X-LABKEY-CSRF': 'TEST_CSRF_TOKEN'
+            }
+        }
+    },
+    moduleFileExtensions: ['ts', 'js'],
+    testEnvironment: 'jsdom',
+    testResultsProcessor: 'jest-teamcity-reporter',
+    testRegex: '(\\.(spec))\\.(ts)$',
+    transform: {
+        '^.+\\.ts$': [
+            'ts-jest',
+            {
+                // This increases test perf by a considerable margin
+                isolatedModules: true,
+            }
+        ],
+    },
+};

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@labkey/api",
-  "version": "1.18.8",
+  "version": "1.19.0",
   "description": "JavaScript client API for LabKey Server",
   "scripts": {
     "build": "npm run build:dist && npm run build:docs",
@@ -39,40 +39,22 @@
     "registry": "https://labkey.jfrog.io/artifactory/api/npm/libs-client"
   },
   "devDependencies": {
-    "@babel/core": "7.18.2",
+    "@babel/core": "7.21.0",
     "@labkey/eslint-config-base": "0.0.12",
-    "@types/jest": "27.5.1",
-    "@types/sinon": "10.0.11",
+    "@types/jest": "29.4.0",
+    "@types/sinon": "10.0.13",
     "cross-env": "7.0.3",
-    "gh-pages": "4.0.0",
-    "jest": "28.1.0",
-    "jest-environment-jsdom": "28.1.0",
+    "gh-pages": "5.0.0",
+    "jest": "29.5.0",
+    "jest-environment-jsdom": "29.5.0",
     "jest-teamcity-reporter": "0.9.0",
-    "rimraf": "3.0.2",
-    "sinon": "14.0.0",
-    "ts-jest": "28.0.3",
-    "ts-loader": "9.3.0",
-    "typedoc": "0.22.17",
-    "typescript": "4.7.2",
-    "webpack": "5.72.1",
-    "webpack-cli": "4.9.2"
-  },
-  "jest": {
-    "globals": {
-      "LABKEY": {
-        "contextPath": "",
-        "defaultHeaders": {
-          "X-LABKEY-CSRF": "TEST_CSRF_TOKEN"
-        }
-      }
-    },
-    "moduleFileExtensions": [
-      "ts",
-      "js"
-    ],
-    "preset": "ts-jest",
-    "testEnvironment": "jsdom",
-    "testResultsProcessor": "jest-teamcity-reporter",
-    "testRegex": "(\\.(spec))\\.(ts)$"
+    "rimraf": "4.3.1",
+    "sinon": "15.0.1",
+    "ts-jest": "29.0.5",
+    "ts-loader": "9.4.2",
+    "typedoc": "0.23.26",
+    "typescript": "4.9.5",
+    "webpack": "5.76.2",
+    "webpack-cli": "5.0.1"
   }
 }

package.json

@@ -75,7 +75,13 @@ describe('ActionURL', () => {
             validatePath('/home/project-begin.view', '', '/home', 'project', 'begin');
             validatePath('/home/with/folder/project-begin.view', '', '/home/with/folder', 'project', 'begin');
             validatePath('/%E2%98%83/%E2%9D%86/%E2%A8%8Drosty-%F0%9D%95%8Anow.view', '', '/☃/❆', '⨍rosty', '𝕊now');
-            validatePath('/home%2C%2B%2B%3B%40%26%3D%24%23%2Cfolder/project-begin.view', '', '/home,++;@&=$#,folder', 'project', 'begin');
+            validatePath(
+                '/home%2C%2B%2B%3B%40%26%3D%24%23%2Cfolder/project-begin.view',
+                '',
+                '/home,++;@&=$#,folder',
+                'project',
+                'begin'
+            );
             validatePath(
                 '/my%20folder/my%20path/pipeline-status-action.view?rowId=123',
                 '',
@@ -111,10 +117,22 @@ describe('ActionURL', () => {
                 'pipeline-status',
                 'action'
             );
-            contextPath ='/my, CommaContext';
+            contextPath = '/my, CommaContext';
             getServerContext().contextPath = contextPath;
-            validatePath(`${contextPath}/1%2C%202/pro%2C%20ject-be%2C%20%2Cgin.view`, contextPath, '/1, 2', 'pro, ject', 'be, ,gin');
-            validatePath(`${contextPath}/1%2C%202%2C%203/project-begin.view`, contextPath, '/1, 2, 3', 'project', 'begin');
+            validatePath(
+                `${contextPath}/1%2C%202/pro%2C%20ject-be%2C%20%2Cgin.view`,
+                contextPath,
+                '/1, 2',
+                'pro, ject',
+                'be, ,gin'
+            );
+            validatePath(
+                `${contextPath}/1%2C%202%2C%203/project-begin.view`,
+                contextPath,
+                '/1, 2, 3',
+                'project',
+                'begin'
+            );
 
             // old style URL
             validatePath(`${contextPath}/project/home/begin.view`, contextPath, '/home', 'project', 'begin');

src/labkey/ActionURL.spec.ts

@@ -280,22 +280,21 @@ export interface ActionPath {
  * @param path to be decoded.
  * @return A new copy of the given path with all encoded characters decoded
  */
-function fullyDecodeURIPath(path: string): string
-{
+function fullyDecodeURIPath(path: string): string {
     return decodeURI(path)
-        .replace(/%2C/g, ",")
-        .replace(/%2B/g, "+")
-        .replace(/%3B/g, ";")
-        .replace(/%40/g, "@")
-        .replace(/%26/g, "&")
-        .replace(/%3D/g, "=")
-        .replace(/%24/g, "$")
-        .replace(/%23/g, "#");
+        .replace(/%2C/g, ',')
+        .replace(/%2B/g, '+')
+        .replace(/%3B/g, ';')
+        .replace(/%40/g, '@')
+        .replace(/%26/g, '&')
+        .replace(/%3D/g, '=')
+        .replace(/%24/g, '$')
+        .replace(/%23/g, '#');
 }
 
 /**
  * Parses a location pathname of a LabKey URL into its constituent parts (e.g. controller, action, etc).
- * Defaults to the current location's pathname and context path. The parsed parts of the [[ActionPath]] are
+ * Defaults to the current location's pathname and context path. The parsed parts of the {@link ActionPath} are
  * URI decoded.
  * #### Example
  *
@@ -323,7 +322,7 @@ function fullyDecodeURIPath(path: string): string
  * @param pathname A pathname to parse. Defaults to value of window.location.pathname.
  * **Note:** This function does not parse full URLs. It expects only the value that would be part of the "pathname"
  * on window.location. See https://html.spec.whatwg.org/multipage/history.html#dom-location-pathname.
- * @param contextPath A context path to parse. Defaults to value returned by [[getContextPath]].
+ * @param contextPath A context path to parse. Defaults to value returned by {@link getContextPath}.
  */
 export function getPathFromLocation(pathname?: string, contextPath?: string): ActionPath {
     const ctxPath = contextPath ?? getContextPath();
@@ -377,7 +376,7 @@ export function getReturnUrl(): string {
 }
 
 /**
- * Turn the parameter object into a query string (e.g. {x:'fred'} -> "x=fred").
+ * Turn the parameter object into a query string (e.g. `{x:'fred'} -> "x=fred"`).
  * The returned query string is not prepended by a question mark ('?').
  *
  * @param parameters An object with properties corresponding to GET parameters to append to the URL.

src/labkey/ActionURL.ts

@@ -114,7 +114,7 @@ export interface RequestOptions {
 
     /**
      * The url used for the XMLHttpRequest. If you are making a request to the LabKey Server instance
-     * see [[ActionURL.buildURL]] for helpful URL construction.
+     * see {@link buildURL} for helpful URL construction.
      */
     url: string;
 }

src/labkey/Ajax.ts

@@ -1,4 +1,4 @@
-type OnInitCallback<CTX> = (target: string, ctx: CTX) => void;
+export type OnInitCallback<CTX> = (target: string, ctx: CTX) => void;
 
 interface AppRegistryItem<CTX = any> {
     appName: string;
@@ -57,7 +57,7 @@ export function init(LABKEY: any) {
 }
 
 /**
- * Load/initialize applications that are registered via [[registerApp]].
+ * Load/initialize applications that are registered via {@link registerApp}.
  * @param appName
  * @param appTarget
  * @param appContext
@@ -88,7 +88,7 @@ export function loadApp<CTX = any>(appName: string, appTarget: string, appContex
 }
 
 /**
- * Registers an app by "appName". When the app is requested to be loaded (via [[loadApp]]) the onInit()
+ * Registers an app by "appName". When the app is requested to be loaded (via {@link loadApp}) the onInit()
  * callback will be invoked to initialize the app.
  * @param appName The unique name for this app type.
  * @param onInit Callback that will be invoked when the app is loaded.

src/labkey/App.ts

@@ -80,7 +80,7 @@ function applyArguments(args: IArguments, options: GetAssaysOptions, parameter?:
  * LABKEY.Assay.getAll({success: successHandler, failure: errorHandler});
  * ```
  * @param options
- * @see [[AssayDesign]]
+ * @see {@link AssayDesign}
  */
 export function getAll(options: GetAssaysOptions): XMLHttpRequest {
     return getAssays(applyArguments(arguments, options));
@@ -170,7 +170,7 @@ export interface GetByIdOptions extends GetAssaysOptions {
 /**
  * Gets an assay by its ID.
  * @param options
- * @see [[AssayDesign]]
+ * @see {@link AssayDesign}
  */
 export function getById(options: GetByIdOptions): XMLHttpRequest {
     return getAssays(applyArguments(arguments, options, 'id'));
@@ -184,7 +184,7 @@ export interface GetByNameOptions extends GetAssaysOptions {
 /**
  * Gets an assay by name.
  * @param options
- * @see [[AssayDesign]]
+ * @see {@link AssayDesign}
  */
 export function getByName(options: GetByNameOptions): XMLHttpRequest {
     return getAssays(applyArguments(arguments, options, 'name'));
@@ -198,7 +198,7 @@ export interface GetByTypeOptions extends GetAssaysOptions {
 /**
  * Gets an assay by type.
  * @param options
- * @see [[AssayDesign]]
+ * @see {@link AssayDesign}
  */
 export function getByType(options: GetByTypeOptions): XMLHttpRequest {
     return getAssays(applyArguments(arguments, options, 'type'));
@@ -214,7 +214,7 @@ export interface GetNAbRunsOptions extends RequestCallbackOptions {
      * If not supplied, the current container's path will be used.
      */
     containerPath?: string;
-    /** Array of objects created by {@link LABKEY.Filter.create}. */
+    /** Array of objects created by {@link create}. */
     filterArray?: IFilter[];
     /** Whether the parameters used in the neutralization curve fitting calculation
      * should be included in the response.*/

src/labkey/Assay.ts

@@ -318,7 +318,7 @@ export function getDomainDetails(config: GetDomainDetailsOptions): XMLHttpReques
 export interface GetDomainOptions extends BaseGetDomainOptions, RequestCallbackOptions<DomainDesign> {}
 
 /**
- * Gets a domain design. This is a deprecated. Use [[getDomainDetails]] instead.
+ * Gets a domain design. This is a deprecated. Use {@link getDomainDetails} instead.
  * @deprecated
  */
 export function get(config: GetDomainOptions): XMLHttpRequest {