Skip to content

Change Log

Change logs for each product below

Connector.SDK

Change log for Trimble.Connector.SDK

v1.4.2

  • Add key length validation for module keys

v1.4.1

  • Fix issue with key length on data objects exceeding length not resulting in an error

v1.4.0

  • Drop support for .NET 7
  • Add support for .NET 9
  • ClientAuthentication added to to OAuth2 base classes
    • This provides a way to indicate how to structure the token request in its delegating handlers
    • By default this value is BasicAuthHeader

v1.3.5

  • Supports OAuth2Password connections definition
  • Fix retry authentication in OAuth2ClientCredentialsHandler

v1.3.4

  • Adds a format intent with a value of int64 to any schema generated from a long type

v1.3.3

  • Pin System.Text.Json version to 8.0.5 to resolve CVE-2024-43485

v1.3.2

  • Add support for enum property schema generation
  • Supports Custom and OAuth2ClientCredentials connections definitions

v1.3.1

  • Support for OAuth2CodeFlow connection definition
  • TokenStorage static class was added with GetOAuthClientTokenResponse<T>() method which retrieves the OAuth client token response stored as an instance of the specified type

v1.3.0

  • Set the following methods as obsolete on IAppNetworkExplorer
    • Task<WrappedHttpResponse<PaginatedResponse<CacheRecord<T>>>> GetCacheRecords<T>
    • IAsyncEnumerable<CacheRecord<T>> GetAllCacheRecords<T>
    • Task<WrappedHttpResponse<PaginatedResponse<AppNetworkExplorerActionInstance>>> GetActions
    • Task<WrappedHttpResponse<PaginatedResponse<AppNetworkExplorerActionInstance>>> GetActionsByStatusAndPath
  • Fix incremental data reader checkpoint not persisting if multiple incremental data readers are enabled to run

v1.2.3

  • Add icon to NuGet package
  • Supports Basic and ApiKey connections definitions
  • Supports testing a connection
  • Improvements and fixes to incremental data reader
    • Update log messages to be more clear and accurate
    • Fix null reference when checkpoint is null on persist after data read
    • Fix cache writer service cash if using incremental data reader with UseChangeDetection enabled

v1.2.2

  • Fix incorrect URL for Connectivity API client

v1.2.1

  • Fix file locking on Windows during App Network emulation
  • Fix false positive schema invalidation on App Network cache emulation
  • Fix incorrect type conversion during App Network emulation key lookup

v1.2.0

  • Target .NET 8
  • Remove support for .NET 6
  • Update Connector internal startup log to read more clearly
  • Remove terminate action handler outcome

v1.1.1

  • Support cross platform SQLite driver

v1.1.0

  • Packaged for distribution via NuGet.org
  • Supports incremental data reading
  • Incorporates change detection libraries

v1.0.0

  • Supports connector extraction using service definition abstractions for action processors, cache writers, clients, and configuration objects
  • Supports schema extraction for action inputs, data objects, and configuration objects
  • Supports System.Text.Json serialization and deserialization for data objects, actions, and change detection
  • Supports compatibility checking between connector and CLI
  • Simplifies usage of change detection interfaces
  • Introduces a standard action failure definition
  • Introduces response and exception conveniences for API clients

Connector.SDK.Local.Test

Change log for Trimble.Connector.SDK.Local.Test

v1.4.0

  • Drop support for .NET 7
  • Add support for .NET 9

v1.3.3

  • Pin System.Text.Json version to 8.0.5 to resolve CVE-2024-43485

v1.3.2

  • Fix cache writing file on action handler returning cache changes with an operation of Upsert

v1.3.1

  • Fix for delete operations when key is not of type string

v1.3.0

  • Adds support for App Network Explorer usage during local emulation
  • Cache database path and name unified to properly manage multiple data objects in emulated cache

v1.2.3

  • Add icon to NuGet package

v1.2.2

  • Fix integer overflow issue when converting number to integer during App Network emulation key lookup

v1.2.1

  • Fix Windows filing locking issue on App Network cache database
  • Fix false positives on schema validation testing for App Network cache database

v1.2.0

  • Target .NET 8
  • Remove support for .NET 6
  • Adds validation for local test run parameters
    • Supplying a parameter not found in service definitions will result in a message displaying all available services
  • Updates to more closely emulate App Network

v1.1.0

  • Packaged for distribution via NuGet.org
  • Supports running connectors locally without appsettings.json

v1.0.0

Supports local simulation of:

  • Creating new cache records
  • Syncing cache records
  • Getting queued actions
  • Action closeouts
  • Sync item errors for bad requests
  • Service runtime configuration information from launch profiles
  • Connector configuration information from test settings

Supports local validation simulation of:

  • Action response schema
  • Data object schema
  • Connector registration
  • Service configuration

Connector.CLI

Change log for Trimble.Connector.CLI

v1.4.0

  • Drop support for .NET 7
  • Add support for .NET 9
  • New command added to retrieve feedback from terminal submissions
    • xchange code feedback --correlation-id {correlation-id}
  • Invoking xchange extract while logged in will result in breaking change detection
    • Breaking change detection validated that the changes to the Connector metadata are safe to apply and will not break any dependents
  • Connector submissions now check for breaking changes before submitting
    • Submissions with breaking changes need to explicitly allow the submission via the --allow-breaking-changes option
  • Submissions can be submitted as a draft if desired. Example: xchange code submit --draft
    • This type of submission indicates to Xchange that you would like early feedback on your Connector development
  • New process for doing extraction of metadata for Connectors on 1.4.x or above
    • Old process can still be used by supplying environment variable XCHANGE_FEATURE_EXTRACT_VIA_CONNECTOR_PROCESS to a falsy value such as 0
  • Automated builds invoked from CLI commands will provide more feedback when codebase deviates from standards
  • Fix unintended warning message showing on xchange code submit commands about mismatching emails

v1.3.9

  • oAuth2Password is now supported for the --auth-type option in the client new command

v1.3.8

  • Adds --no-pagination option to data-object new command
  • Updates code generation for:
    • Data Readers
    • Action Handlers
    • API Client support classes
      • Renames Result property to Data on ApiResponse class
      • Adds new generic pagination response class
  • Updates to code list command
    • Adds a --limit option
      • Default value is 10 with a max of 50
    • Orders submissions by oldest to newest
  • The --submitter option no longer required if logged in
  • Creating submissions will now reference the Connector.sln file for navigating projects used
  • The option --token is replaced with --api-key
    • --token will continue to work

v1.3.7

  • Adding a fix to recover from any malformed encrypted token files
    • This will delete the file and require a new log in

v1.3.6

  • Reduce log outputs when running code submit
    • Files in .git directory will not be shown as being skipped due to not in whitelist
  • Fix issue on --dry-run flag runs of code submit not producing a new archive
  • Add auto building of Connector on extract and test init commands
  • Newly generated API clients come with an example TestConnection method

v1.3.5

  • Fix Windows deletion error after a successful submission
  • Add --dry-run flag to code submit command
    • This allows users to go through the submission process without actually creating a submission
  • Add --validate-only flag to extract command
    • This will not generate a connector.json file, only validate the schema produced

v1.3.4

  • Fix deadlock on code submit during MSBuild

v1.3.3

  • Pin System.Text.Json version to 8.0.5 to resolve CVE-2024-43485

v1.3.2

  • extract command will now properly generate schema for enum property types
  • Properly extract metadata from incremental data readers
  • Generated code from template for incremental data reader will not have build errors
  • Health checks are now opt-in for module new
    • If health checks are desired then adding the option --add-health-checks should be added to the module new command
  • Will now early exit if a command is invoked with an unknown argument
    • A log message is included indicating what was unknown
  • custom and oAuth2ClientCredentials are now supported for the --auth-type option in the client new command
    • --auth-type option is now required on client new
  • Allow GraphQL files in Connector archives
  • Display log messages for each file not being included in Connector archive
  • Update code submission build logic to be ran in isolation
    • This is done by creating a copy of files to be archived into a temporary directory

v1.3.1

  • oAuth2CodeFlow is now supported for the --auth-type option in the client new command
  • test reset was updated to remove locally stored authentication tokens in addition to clearing the local database

v1.3.0

  • Update logic for code generation to ensure module new, data-object new, and action new is not dependent on client new being first ran
  • Add support for logging into Xchange through Trimble ID
    • Upon logging in your token will be encrypted and persisted in your operating system's local application data directory under a directory named xchange
    • This token can be used for running code commands
  • code commands no longer require a --api-key option
    • If --api-key option is not supplied then the CLI will first direct you to login via Trimble ID before running the command

v1.2.3

  • Add icon to NuGet package
  • client new has --auth-type option, which will generate a Connections directory, authentication classes and handlers for the client.
    • Supports Basic and ApiKey
    • A ConnectionTestHandler will be included
  • extract will include configuration from the authentication classes
  • test init will generate test settings for authentication using the authentication classes
  • Updates incremental data reader template to not default to a timestamp for its checkpoint value in example override
  • Improve log message after running connector new
    • This message will now provide more context on what to do
  • Remove duplication file creation of cache writer service definition on module new

v1.2.2

  • connector new command will generate a project targeting the latest stable version of SDK
    • A --allow-prerelease option has been added
  • connector new project structure has been updated to match expectation
    • Connector project moved into a Connector directory
    • A solution file is generated at level of connector directory
  • --version command will display SDK version if executed in a Connector project
  • .gitignore generated by connector new no longer ignore launchsettings.json
  • Added pre-checks that are ran before each command. Current pre-checks are:
    • Check if CLI is out of date
      • Warning severity if major or minor out of date
      • Information severity if patch out of date
    • If CLI running in Connector project then it will also check if used Xchange libraries are out of date
      • Warning severity if major or minor out of date
      • Information severity if patch out of date

v1.2.1

  • Fix loading of third party dependencies during extract command

v1.2.0

  • Target .NET 8
  • Remove support for .NET 6
  • Fix reflection issue on extract step when SDK and CLI's SDK version differ
  • Add --force option to publish command

v1.1.0

  • Packaged for distribution via NuGet.org

Provides generation commands for creating:

  • New connector scaffolding to develop a connector
  • HTTP API clients and helper classes
  • Healthcheck data objects and actions

Provides commands for:

  • Submitting connectors for review
  • Checking the status of connector submissions
  • Closing an in process connector submission

v1.0.0

  • Packaged for installation as a global .NET tool

Provides generation commands for creating:

  • General-purpose data readers using generic clients
  • General-purpose action processors using generic clients
  • New modules

Provides commands for:

  • Initializing local test settings
  • Resetting local test change detection
  • Extracting connector metadata from the connector codebase
  • Publishing connector metadata to the Xchange platform

Supports:

  • Creating an action and action handling without a data reader
  • Multiple modules
  • Publishing extraction with an Xchange API key