@tetrascience-npm/ts-connectors-sdk 3.1.0

package/CHANGELOG.md

@@ -0,0 +1,201 @@
+# Major Changes
+
+## 3.1.0
+
+* Prepare initial public npm release of `@tetrascience-npm/ts-connectors-sdk`.
+* Change project license from MIT to Apache 2.0 to align with public SDK requirements.
+* No runtime behavior changes since 3.0.1-rc2; 3.1.0 is identical to 3.1.0-rc1 aside from licensing, packaging, and documentation updates.
+
+## 3.1.0-rc1
+
+* Fix some minor issues with user agent config published in v3.0.1-rc2
+* Increment minor version to signify new feature
+
+## 3.0.1-rc2
+
+* Added User-Agent header support to all TDP API requests
+  * Default format is `<connector-slug> v<connector-version>` using information from manifest.json
+  * If manifest.json is not available, defaults to `PluggableConnector TDPClient`
+  * Setting `TS_SDK.TS_SDK_DISABLE_USER_AGENT_HTTP_HEADER` to `true` in the connector KV store will disable the custom behavior and revert to use the default axios user agent
+    * In the connector KV store, `TS_SDK` is the key and the expected value is a JSON object with the key `TS_SDK_DISABLE_USER_AGENT_HTTP_HEADER` and a boolean value
+    * Example: `{"TS_SDK_DISABLE_USER_AGENT_HTTP_HEADER": true}`
+
+## 3.0.1-rc1
+
+* Sends command REJECTED instead of SUCCESS when processing an unrecognized command
+
+## 3.0.0
+
+* When initializing with CONNECTOR_TOKEN env var, explicitly writes logs to AWS Cloudwatch in addition to stdout.
+* Added a peer dependency on `@aws-sdk/client-cloudwatch-logs@>=3.0.0 <4.0.0` to support AWS Cloudwatch logging
+* Also adds the following configuration env vars to override various aspects of this behavior:
+  * SKIP_CLOUDWATCH - disables cloudwatch logging entirely.
+  * CLOUDWATCH_BUFFER_LIMIT - how many messages will be stored in the cloudwatch buffer before we begin discarding them to prevent memory issues. Default 5000.
+  * CLOUDWATCH_FLUSH_LIMIT - how many messages will be stored in the cloudwatch buffer before we trigger a flush. Default 100.
+  * CLOUDWATCH_FLUSH_INTERVAL - how long we will wait after each flush before triggering the next one, in milliseconds. Default 30 * 1000.
+* When a connector is shutdown the base `Connector` class now calls the [shutdown method](https://github.com/tetrascience/ts-sdk-connectors-nodejs/blob/2374b65db6ce8d28bb6545db8f6fe30125ad1f4f/src/connector.ts#L312) instead of the `onShutdown` method
+  * The `shutdown` method of the base class will call the `onShutdown` method before the base connector performs some cleanup
+  * Any developer that overrides the base `shutdown` method must invoke `super.shutdown` to perform proper cleanup
+
+## 2.3.0
+
+* Add `destinationId` as option to `tdpClient.uploadFile`. This allows connectors to use a different UUIDv4 in place of the connector ID when creating file keys in the datalake
+* Fix bug where HTTPS proxy ignored `rejectUnauthorized` setting
+* Support SDK initialization with a TDP JWT in the CONNECTOR_TOKEN env var. When this is supplied, the SDK will operate in Standalone mode, exchanging this JWT for a temporary AWS credential and supplying AWS SDK clients with those credentials instead of relying on AWS credentials in the environment.
+
+## 2.2.7
+
+* Improved logging of environmental proxy settings when not set via Hub env file
+* Supports HTTP_PROXY, HTTPS_PROXY, and NO_PROXY via environment variables when the hub proxy env file is not available. Previously only the lowercase versions http_proxy, https_proxy, and no_proxy were supported.
+
+## 2.2.6
+
+* Added object size and abort controller options to `tdpClient.uploadFile`
+* Updated various AWS SDK libraries, including `@smithy/node-http-handler`
+
+## 2.2.5
+
+* Added content type and encoding to `tdpClient.uploadFile`
+
+## 2.2.4
+
+* Updated dependencies to clear vulnerability warnings
+
+## 2.2.3
+
+* Removed incorrect validation on file upload 'trace' value
+* Exports upload file request validation schemas
+
+## 2.2.2
+
+* Fixed incorrect response code and message for failed key validation
+
+## 2.2.1
+
+* Fix HTTP proxy and certificate support for TDPClient.
+* Adds support of `NODE_TLS_REJECT_UNAUTHORIZED` environment variable to disable TLS certificate validation.
+* Add support for `HTTPS_AGENT` environment variable to override the default HTTPS agent. Possible values: `hpagent`.
+
+## 2.2.0
+
+* Add support for large command payloads (passed over s3 signed URLs) handling.
+  * Breaking change: `Command` type is split to `CommandRequest` and `CommandResponse` types.
+
+## 2.1.2
+
+* Allow requestId in all sdk queries, generated one if none is passed.
+
+## 2.1.1
+
+* Fixed an issue where saveFile failures do not report the correct error message.
+
+## 2.1.0
+
+* uploadFile validates provided metadata, tags, labels, and trace against TDP 3.6 MTL rules.
+  * Connector uploadFile requests using invalid metadata will now log a warning containing the validation failures.
+  * During development or for stricter behavior, you can pass strictMtlValidation: true to instead throw an error containing the validation failures.
+  * These rules are slightly more lenient than TDP 3.5 rules around [multibyte labels in particular](https://developers.tetrascience.com/docs/creating-and-deleting-custom-labels-metadata-and-tags#create-a-new-label), so be aware that such labels will pass this validation but may cause problems in TDP 3.5.
+
+## 2.0.1
+
+* Fixed an issue where PollingConnector restarts running on updates.
+
+## 2.0.0
+
+* Moved aws-sdk and axios to dev dependencies
+  * Connectors using this version will need to depend on a compatible library version:
+    * @aws-sdk/client-s3: >=3.0.0 <4.0.0
+    * @aws-sdk/client-sqs: >=3.0.0 <4.0.0
+    * @aws-sdk/client-ssm: >=3.0.0 <4.0.0
+    * @aws-sdk/lib-storage: >=3.0.0 <4.0.0
+    * axios: >=1.5.0 <2.0.0
+
+## 1.1.6
+
+* Added checksum functionality
+  * Automatically populates MD5 checksums for files uploaded
+  * Optional checksumAlgorithm parameter overrides the default SHA256
+  * Also allows raw checksum uploads that are saved as metadata
+    * rawXXXChecksum, where XXX is one of Md5, Sha1, Sha256, Crc32, Crc32c, saved in checksums object
+
+## 1.1.5
+
+* Added baseURL to tdp-client options
+* Added checks to prevent certificate lookup to fire errors on setup/restart
+* Sanitized axios logging configuration
+* Removed connectorSlug from traceMetadata
+
+## 1.1.4
+
+* Updated Dependencies to Fix Vulnerabilities
+
+## 1.1.3
+
+* Replaces @aws-sdk/node-http-handler with @smithy/node-http-handler
+
+## 1.1.2
+
+* Makes @aws-sdk/node-http-handler an explicit dependency, as it was removed from @aws-sdk/client-s3 dependencies
+
+## 1.1.1
+
+* Added error information in response messages for commands
+
+## 1.1.0
+
+* Loads a certificate file from STREAM_BUCKET/TDP_CERTIFICATE_KEY if one exists, allowing Connectors to trust a self-signed certificate for the TDP API.
+
+## 1.0.0
+
+* Adds API.getCertificates - calls TDP endpoint to download organization CA certificates
+* Adds TDPClient.getCertificates - wrapper around API.getCertificates that supplies connector org slug
+* Adds TDPClient.certificates - setup during initialization from the methods above, contains an array of organization certificate CAs that should be trusted for  outgoing http requests.
+
+### Breaking Changes
+
+* The signature of TDPClient.createProxyAgentsForBaseUrl has changed to take an options object instead of primitive parameters.
+
+## 0.12.1
+
+* Updated testing support for v16, 18, and 20.
+
+## 0.12.0
+
+* Added connector metadata to s3 metadata for files uploaded to TDP
+
+## 0.10.1
+
+* Simplify loading of files to processed. Logic moved to the base `Connector` class.
+
+### Breaking Changes
+
+* None
+
+## 0.10.0
+
+* Reject expired commands and do not emit messages for them
+
+### Breaking Changes
+
+* `ConnectorFileDto`.`externalId` has been renamed to `uniqueExternalId`
+* `TdpClient`.`getFiles` returns 50 files by default instead of all
+
+## 0.9.0
+
+* Reject expired commands and do not emit messages for them
+
+### Breaking Changes
+
+* None
+
+## 0.5.1
+
+* Changelog introduced
+
+### Breaking Changes
+
+* None
+
+### Breaking Changes
+
+* None yet

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,123 @@
+## @tetrascience-npm/ts-connectors-sdk
+
+TetraScience Node.js Connectors SDK.
+
+Provides base classes and utilities for building TetraScience Connectors in Node.js.
+
+It is primarily intended to be used by TetraScience connectors running on the
+Tetra Data Platform (TDP).
+
+## Installation
+
+This SDK relies on a small set of peer dependencies that your application must
+provide. These are not bundled with the SDK so that you can control the exact
+versions used in your environment.
+
+Required peer dependencies:
+
+- `@aws-sdk/client-cloudwatch-logs`
+- `@aws-sdk/client-s3`
+- `@aws-sdk/client-sqs`
+- `@aws-sdk/client-ssm`
+- `@aws-sdk/lib-storage`
+- `axios`
+
+If you are not already using these packages, you can install everything together:
+
+Using **npm**:
+
+```bash
+npm install @tetrascience-npm/ts-connectors-sdk \
+  @aws-sdk/client-cloudwatch-logs @aws-sdk/client-s3 \
+  @aws-sdk/client-sqs @aws-sdk/client-ssm @aws-sdk/lib-storage axios
+```
+
+Using **Yarn**:
+
+```bash
+yarn add @tetrascience-npm/ts-connectors-sdk \
+  @aws-sdk/client-cloudwatch-logs @aws-sdk/client-s3 \
+  @aws-sdk/client-sqs @aws-sdk/client-ssm @aws-sdk/lib-storage axios
+```
+
+If your project already depends on the AWS SDK v3 clients or `axios`, you only
+need to add `@tetrascience-npm/ts-connectors-sdk` and ensure that your existing
+versions satisfy the peer dependency ranges in `package.json`.
+
+This SDK is tested with Node.js versions 16, 18, and 20 (see the `engines` field in
+`package.json`).
+
+## Overview
+
+The SDK exposes the following primary building blocks:
+
+- **TDPClient** – wraps the Tetra Data Platform data-acquisition API and handles
+  datalake uploads directly to S3, including metadata options and validation.
+- **Connector** – base class that encapsulates common connector lifecycle concerns
+  such as initialization, health reporting, metrics, and command handling.
+- **PollingConnector** – extends `Connector` with a polling loop implementation
+  suitable for connectors that primarily poll external systems on an interval.
+
+All of these are exported from the package root, for example:
+
+```ts
+import { Connector, PollingConnector, TDPClient } from '@tetrascience-npm/ts-connectors-sdk';
+```
+
+## Basic usage
+
+### TDPClient
+
+In a typical connector environment, `TDPClient` is initialized with configuration
+derived from the connector runtime (environment variables, manifests, and
+connector settings). At a high level you use it to make API calls and upload
+files into the Tetra Data Platform:
+
+```ts
+import { TDPClient } from '@tetrascience-npm/ts-connectors-sdk';
+
+async function uploadExample() {
+  const client = new TDPClient(/* see source for available options */);
+
+  await client.uploadFile({
+    content: Buffer.from('example'),
+    filepath: 'path/in/datalake/example.txt',
+    // Optional metadata, tags, labels, and other fields are validated
+    // against the platform metadata rules.
+  });
+}
+```
+
+Refer to the `TDPClient` source (`src/tdp-client.ts`) for the full set of
+options and behaviors.
+
+### Connector and PollingConnector
+
+To build a connector, extend either `Connector` or `PollingConnector` and
+implement the appropriate hooks for your integration.
+
+```ts
+import { PollingConnector } from '@tetrascience-npm/ts-connectors-sdk';
+
+class MyPollingConnector extends PollingConnector {
+  // Implement required hooks such as poll(), onStartup(), onShutdown(), etc.
+}
+```
+
+The base classes handle boilerplate such as:
+
+- Connector lifecycle and shutdown behavior
+- Health and metrics reporting
+- Command reception and dispatch
+
+## Versioning and changelog
+
+All notable changes are documented in [CHANGELOG.md](./CHANGELOG.md).
+
+## Contributing
+
+For more details, see [CONTRIBUTING.md](./CONTRIBUTING.md).
+
+## License
+
+This project is licensed under the [Apache License 2.0](./LICENSE).

package/dist/api-tests/configuration.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=configuration.test.d.ts.map

package/dist/api-tests/configuration.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configuration.test.d.ts","sourceRoot":"","sources":["../../api-tests/configuration.test.ts"],"names":[],"mappings":""}

package/dist/api-tests/configuration.test.js

@@ -0,0 +1,49 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = __importDefault(require("lodash"));
+const vitest_1 = require("vitest");
+const fixture_1 = require("./fixture/fixture");
+(0, vitest_1.describe)('Configuration', () => {
+    (0, fixture_1.connectorTest)('DAM-T81: Standalone connector does not change for invalid configuration', (_a) => __awaiter(void 0, [_a], void 0, function* ({ expect, connectorApi, standaloneConnector }) {
+        yield standaloneConnector.start();
+        const onlineCheck = yield connectorApi.waitForConnectorToBeOnline(standaloneConnector.connector.id);
+        expect(onlineCheck.status).toBe(200);
+        expect(onlineCheck.data.operatingStatus).toBe('IDLE');
+        const originalConnector = lodash_1.default.cloneDeep(standaloneConnector.connector);
+        const invalidConfig = { name: 'test-user' };
+        yield connectorApi.updateConfiguration(standaloneConnector.connector.id, invalidConfig);
+        const validationResults = standaloneConnector.configValidationAttempts;
+        expect(validationResults).toHaveLength(1);
+        expect(validationResults[0].result.valid).toBe(false);
+        expect(standaloneConnector.connector).toEqual(originalConnector);
+        expect(standaloneConnector.updateCounts).toBe(0);
+    }));
+    (0, fixture_1.connectorTest)('DAM-T83: Standalone connector updates on valid configuration', (_a) => __awaiter(void 0, [_a], void 0, function* ({ expect, connectorApi, standaloneConnector }) {
+        yield standaloneConnector.start();
+        const onlineCheck = yield connectorApi.waitForConnectorToBeOnline(standaloneConnector.connector.id);
+        expect(onlineCheck.status).toBe(200);
+        expect(onlineCheck.data.operatingStatus).toBe('IDLE');
+        const originalConnector = lodash_1.default.cloneDeep(standaloneConnector.connector);
+        const validConfig = { username: 'test' };
+        yield connectorApi.updateConfiguration(standaloneConnector.connector.id, validConfig);
+        const validationResults = standaloneConnector.configValidationAttempts;
+        expect(validationResults).toHaveLength(1);
+        expect(validationResults[0].result.valid).toBe(true);
+        expect(standaloneConnector.connector).not.toEqual(originalConnector);
+        expect(standaloneConnector.config).toEqual(validConfig);
+        expect(standaloneConnector.updateCounts).toBe(1);
+    }));
+});
+//# sourceMappingURL=configuration.test.js.map

package/dist/api-tests/configuration.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configuration.test.js","sourceRoot":"","sources":["../../api-tests/configuration.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,oDAAuB;AACvB,mCAAkC;AAElC,+CAAkD;AAElD,IAAA,iBAAQ,EAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,IAAA,uBAAa,EACX,yEAAyE,EACzE,KAAsD,EAAE,4CAAjD,EAAE,MAAM,EAAE,YAAY,EAAE,mBAAmB,EAAE;QAClD,MAAM,mBAAmB,CAAC,KAAK,EAAE,CAAC;QAClC,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,0BAA0B,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACpG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEtD,MAAM,iBAAiB,GAAG,gBAAC,CAAC,SAAS,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;QACrE,MAAM,aAAa,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;QAE5C,MAAM,YAAY,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;QAExF,MAAM,iBAAiB,GAAG,mBAAmB,CAAC,wBAAwB,CAAC;QACvE,MAAM,CAAC,iBAAiB,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC1C,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtD,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACjE,MAAM,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACnD,CAAC,CAAA,CACF,CAAC;IAEF,IAAA,uBAAa,EACX,8DAA8D,EAC9D,KAAsD,EAAE,4CAAjD,EAAE,MAAM,EAAE,YAAY,EAAE,mBAAmB,EAAE;QAClD,MAAM,mBAAmB,CAAC,KAAK,EAAE,CAAC;QAClC,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,0BAA0B,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACpG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEtD,MAAM,iBAAiB,GAAG,gBAAC,CAAC,SAAS,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;QACrE,MAAM,WAAW,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;QAEzC,MAAM,YAAY,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QAEtF,MAAM,iBAAiB,GAAG,mBAAmB,CAAC,wBAAwB,CAAC;QACvE,MAAM,CAAC,iBAAiB,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC1C,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrD,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACrE,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACxD,MAAM,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACnD,CAAC,CAAA,CACF,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/dist/api-tests/connector-lifetime.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=connector-lifetime.test.d.ts.map

package/dist/api-tests/connector-lifetime.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connector-lifetime.test.d.ts","sourceRoot":"","sources":["../../api-tests/connector-lifetime.test.ts"],"names":[],"mappings":""}

package/dist/api-tests/connector-lifetime.test.js

@@ -0,0 +1,64 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const types_js_1 = require("../src/types.js");
+const assertions_1 = require("./fixture/assertions");
+const fixture_1 = require("./fixture/fixture");
+(0, vitest_1.describe)('Connector lifetime', () => {
+    (0, fixture_1.connectorTest)('DAM-T82: Connector can transition between idle and running', (_a) => __awaiter(void 0, [_a], void 0, function* ({ standaloneConnector, connectorApi, expect }) {
+        yield standaloneConnector.start();
+        const onlineCheck = yield connectorApi.waitForConnectorToBeOnline(standaloneConnector.connector.id);
+        expect(onlineCheck.status).toBe(200);
+        expect(standaloneConnector.connector.operatingStatus).toBe('IDLE');
+        expect(onlineCheck.data.operatingStatus).toBe('IDLE');
+        yield connectorApi.setStatus(standaloneConnector.connector.id, 'RUNNING');
+        const command = yield standaloneConnector.waitForCommand(types_js_1.CommandAction.Start);
+        expect(command).toBeDefined();
+        expect(standaloneConnector.connector.operatingStatus).toBe('RUNNING');
+        const apiResponse = yield connectorApi.get(standaloneConnector.connector.id);
+        expect(apiResponse.status).toBe(200);
+        expect(apiResponse.data.operatingStatus).toBe('RUNNING');
+    }));
+    (0, fixture_1.connectorTest)('DAM-T84: Disabling connector invalidates auth token', { timeout: 10 * 60 * 1000 }, (_a) => __awaiter(void 0, [_a], void 0, function* ({ standaloneConnector, connectorApi, expect, config, delay }) {
+        var _b, _c;
+        yield standaloneConnector.start();
+        const onlineCheck = yield connectorApi.waitForConnectorToBeOnline(standaloneConnector.connector.id);
+        expect(onlineCheck.status).toBe(200);
+        expect(onlineCheck.data.networkStatus).toBe('Online');
+        const disableRes = yield connectorApi.setStatus(standaloneConnector.connector.id, 'DISABLED');
+        expect(disableRes.status).toBe(200);
+        const shutdownCommand = yield standaloneConnector.waitForCommand(types_js_1.CommandAction.Shutdown);
+        expect(shutdownCommand).toBeDefined();
+        // it takes 3 minutes for the connector to be shown as offline
+        yield delay(3 * 60);
+        const offlineCheck = yield connectorApi.waitForConnectorToBeOffline(standaloneConnector.connector.id);
+        expect(offlineCheck.status).toBe(200);
+        expect(offlineCheck.data.networkStatus).toBe('Offline');
+        try {
+            yield standaloneConnector.uploadFile(config);
+            expect.fail('Expected upload to fail');
+        }
+        catch (e) {
+            (0, assertions_1.expectToBeAxiosError)(expect, e);
+            expect((_b = e.response) === null || _b === void 0 ? void 0 : _b.status).toBe(401);
+        }
+        try {
+            yield standaloneConnector.uploadFile(config);
+            expect.fail('Expected upload to fail');
+        }
+        catch (e) {
+            (0, assertions_1.expectToBeAxiosError)(expect, e);
+            expect((_c = e.response) === null || _c === void 0 ? void 0 : _c.status).toBe(401);
+        }
+    }));
+});
+//# sourceMappingURL=connector-lifetime.test.js.map

package/dist/api-tests/connector-lifetime.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connector-lifetime.test.js","sourceRoot":"","sources":["../../api-tests/connector-lifetime.test.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,mCAAkC;AAElC,8CAAgD;AAChD,qDAA4D;AAC5D,+CAAkD;AAElD,IAAA,iBAAQ,EAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,IAAA,uBAAa,EACX,4DAA4D,EAC5D,KAAsD,EAAE,4CAAjD,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,EAAE;QAClD,MAAM,mBAAmB,CAAC,KAAK,EAAE,CAAC;QAClC,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,0BAA0B,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACpG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAErC,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnE,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEtD,MAAM,YAAY,CAAC,SAAS,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;QAC1E,MAAM,OAAO,GAAG,MAAM,mBAAmB,CAAC,cAAc,CAAC,wBAAa,CAAC,KAAK,CAAC,CAAC;QAC9E,MAAM,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;QAE9B,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAEtE,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,GAAG,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAC7E,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC3D,CAAC,CAAA,CACF,CAAC;IAEF,IAAA,uBAAa,EACX,qDAAqD,EACrD,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,EAC3B,KAAqE,EAAE,4CAAhE,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE;;QACjE,MAAM,mBAAmB,CAAC,KAAK,EAAE,CAAC;QAClC,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,0BAA0B,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACpG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEtD,MAAM,UAAU,GAAG,MAAM,YAAY,CAAC,SAAS,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;QAC9F,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEpC,MAAM,eAAe,GAAG,MAAM,mBAAmB,CAAC,cAAc,CAAC,wBAAa,CAAC,QAAQ,CAAC,CAAC;QACzF,MAAM,CAAC,eAAe,CAAC,CAAC,WAAW,EAAE,CAAC;QAEtC,8DAA8D;QAC9D,MAAM,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;QACpB,MAAM,YAAY,GAAG,MAAM,YAAY,CAAC,2BAA2B,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACtG,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAExD,IAAI,CAAC;YACH,MAAM,mBAAmB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC7C,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QACzC,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,IAAA,iCAAoB,EAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAChC,MAAM,CAAC,MAAA,CAAC,CAAC,QAAQ,0CAAE,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvC,CAAC;QAED,IAAI,CAAC;YACH,MAAM,mBAAmB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC7C,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QACzC,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,IAAA,iCAAoB,EAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAChC,MAAM,CAAC,MAAA,CAAC,CAAC,QAAQ,0CAAE,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvC,CAAC;IACH,CAAC,CAAA,CACF,CAAC;AACJ,CAAC,CAAC,CAAC"}