v1.0.0

StevanFreeborn released this 20 Feb 23:10

· 70 commits to master since this release

c9a7262

1.0.0 (2023-02-20)

Bug Fixes

add api response factory tests (cad208c)
add dotenv vault (e870722)
add eslint and configure it (bd55381)
add js doc comments. (fac2367)
add jsdoc comments (287289b)
add jsdoc comments (3168a70)
add jsdoc comments (b6605a4)
add missing js doc comments (f5ce1d8)
add missing jsdoc comments (4324610)
add missing JSDoc comments (7cacd45)
add missing JSDoc comments (23227ca)
add missing tests (9ab72bd)
add models and enums to package index as exports (2d345a6)
add optional config parameter to get method (34edc66)
add README (d89768b)
add test and format to build script (88bf080)
add tests for enums (c5de013)
add timeout and retry settings to canConnect integration test (b6bc26e)
added additional negative test cases for getApps method. feat: begin writing tests for getAppById method (1a6d05a)
added another test for new api response method (1d4d547)
added clean step to build process (3af7368)
added dependencies for development. feat: added axios as dependency. feat: added some initial modeals. feat: setup unit testing (dc90ac9)
added jsdoc comments (9e46404)
added JSDoc comments for getFieldsByAppId implementation (5e80aaa)
added JSDoc comments for getFieldsByIds implementation (0559f60)
added module resolution to tsconfig (fba62f8)
added new tsconfig files to vcs (ee8594d)
added support for publishing both cjs and esm (081fb73)
added test for new api response method (0bb9b07)
added tests for GetPagedFieldsResponse (1b046b4)
added tests to cover unsuccessful responses to getAppById method (2238e34)
adjust how passed in axios configs are combined with default axios configs in client constructor (d6c6579)
allow value property of record value model to be generically typed. feat: added methods to record model to allow adding a record value to the field data property or adding multiple record values to the field data property. wrote tests for these two new methods. (ec82dd0)
begin configuring release versioning (a868811)
begin writing Lists integration tests. fix: list item response model's id value should be of type string so modified the created with id response model that it extends so that the id property is generically typed and type can be passed in. (bc8b9a4)
build script (32a680e)
build script (28ae3ee)
build script in package.json (3c63320)
build workflow (b340989)
bump package version (8087b41)
bump package version (534169d)
complete code test coverage (af806e7)
configuration: setup semantic versioning for pushes to the master or beta branches (a6a98f2)
correct workflow (ccc8f67)
correct workflow (5250304)
corrected file name (1c07a78)
corrected JSDoc comments (54b0668)
corrected JSDoc comments (923cb27)
enabled strict null checks and made changes to deal with this compiler change. fix: modified endpoint factory methods to not need baseURL to be passed in. instead just return endpoint because the axios client with already have a default url set as part of constructing a new onspring client instance (d453f19)
example.env merge conflict (48d13ea)
implement formula field, list field, and reference field as chilrden of the field class. fix: when converting api response data to appropriate field response make sure json field objects are converted to correct field class based upon type. (e6eae35)
implement read method for readables created in tests (c804bcc)
in can connect test mock underlying axios instance's get method (fa1a952)
incorrect field status in getFieldsByAppId mock api data (0c5b3bf)
jsdoc comment (61cb4d2)
make precommit executable (1b2c0e3)
make workflow ignore changes in certain paths (f202e01)
make workflow ignore changes in certain paths (5482b46)
make workflow ignore changes in certain paths (9a8cdad)
make workflow ignore changes in certain paths (8e43088)
modified name of main file. fix: moved client inside models folder (9a7d239)
move publish test coverage to separate job. feat: add format job. (604d743)
ordered imports (5b25a99)
organize integration tests according to method targets. fix: set timeouts and retries for integration tests (d314b17)
package-lock.json: updated package-lock.json (d4ec91e)
properly implement saveFile method and write test (ed68b5f)
read base url from env file in integration tests (6f0d85b)
refactor to have child classes that inherit from RecordValue, but represent the distinct types of value objects that can be returned by the api. fix: added and updated tests to address this refactor (74d2470)
release-configuration: update releaserc.json (c9a7262)
release-configuration: update releaserc.json (870be7d)
release-configuration: update releaserc.json (fd376b5)
remove duplicate test run in pre-commit hook (be9db8e)
remove husky from package.json (f7229b5)
remove todos (8b61dfa)
remove unused import (2f26149)
remove unused import (9cd2495)
remove vscode settings directory (62a7c7b)
removed husky from gitignore (682dd24)
renamed lint fix script (4103d02)
resolve linter errors (192a5ee)
resolve linter errors (9e6b9f3)
resolve linter errors (103baf8)
resolve linter errors (dfeead8)
resolve linter errors (be4a85f)
resolve linter errors (0b223f3)
resolve linter errors (47da05a)
resolve linter errors (7e98165)
resolve merge conflict (88531bc)
set validateStatus property of axios instance to null so that the package can handle all the api responses internally. feat: added ability to provide axios instance configuration to the OnspringClient constructor. (64dfa6f)
spelling error (7114649)
test formatting (0580ce5)
test formatting (143b46d)
test formatting (f060c7d)
test formatting (e6cde7f)
test formatting (396d8ae)
test formatting (fcbe5fa)
test formatting (b4bd721)
test formatting (ec0fe82)
test workflow (5dc36e2)
types declaration path (14af028)
update build script (7cb0219)
update check out repository step (7135d55)
update example.env (9ac79b0)
update import statement for package exports in integration tests to have an inferred path to the index file (369540d)
update install dependency step (335cfe2)
update integration tests to use a root beforeAll hook that loads the environment variables and assigns values to the api key and base url to be used when constructing the onspring client used in the integration tests (8e1d905)
update integration tests to use correct env variables (cc3eea5)
update lint job to only run on one version of node (3e4f704)
update package name (1255b93)
update package name (e3ad9ad)
update package version (1f11b05)
update package version (f889ffa)
update package version (74927c8)
update package.json (c8fc811)
update package.json versioning (42da7a9)
update package.json versioning and engine info. fix: added triggers to workflow for pushing to master branch or pr's targeting master branch (b4fcc6d)
update package.json with files field (2fc114a)
update README (d35f845)
update s-node compiler setting (7db5ff5)
update so that pre-commit hook only includes running unit tests as part of test coverage, but when run as part of ci integration tests will be run as part of test coverage (d6dd941)
update test scripts in package.json (9055e9c)
update workflow (89edc0b)
update workflow (b8913a1)
update workflow (8175a4e)
update workflow (f73ccef)
update workflow (36fd4ea)
update workflow (3d1602a)
update workflow (775ee6b)
update workflow (3a249e8)
update workflow (d85fb66)
update workflow (df40112)
update workflow (69776a3)
update workflow (99e5242)
update workflow (6540fb1)
update workflow (cc0afa8)
update workflow (34e608b)
update workflow (639d767)
update workflow name (58c4a51)
updated husky pre-commit hook to run linting fix, tests, test-coverage, and formatting (88197d7)
updated package-lock.json (9c3a8da)
updated strategy to not fail fast (52d2a4e)
work through how i want to return the api response with the data property being of the right type. (4952bf3)
workflow_dispatch (f4934e4)
workflows: update workflow to only run on pull requests to master branch (9e0c04e)

Features

add all tests for getRecordsByAppId method (9bfdf59)
add CollectionResponse model and tests (3e78a35)
add commit changes step (0fd73a6)
add coverage report upload (ab32a83)
add filter operator enum, add models for getting records by ids and querying records (827ad9c)
add get apps method (5a6c509)
add getAppById, getAppsByIds, and getFieldById integration tests (927fcd4)
add GetRecordsByAppIdRequest model (a874f8a)
add integration test for canConnect method (4b7bcc1)
add integration tests for deleteFileById method (ace07c9)
add integration tests for deleteRecordById method. fix: add toJSON method on SaveRecordRequest model to handle converting fields map to a POJO before sending in request (99c7e7f)
add integration tests for getFileInfoById method. fix: add example.env that is used in integration tests (4370574)
add integration tests for getRecordById method (06dda79)
add integration tests for getRecordsByAppId method (e711553)
add integration tests for getRecordsByIds method (23875cf)
add integration tests for getReportById and getReportsByAppId methods (4001fb4)
add integration tests for queryRecords and deleteRecordsByIds methods. fix: implemented deleteRecordsByIds method and wrote unit tests (3bf65f2)
add integrationTests for saveRecord method (9c44efe)
add test job (7dc123f)
add tests for isValidPageSize and isValidPageNumber methods (12f32bc)
added all enums needed (fcc4799)
added getFieldsByAppId integration tests (4fe1d7c)
added getFieldsByIds integration tests (97ae716)
added http status code enum (49ab392)
added integration tests for addOrUpdateListItem method (bee453f)
added integration tests for deleteListItemById.spec.ts (bef98dd)
added integration tests for saveFile method (c1ff572)
added license text (5cec906)
added model to represent and construct filters when querying for records (d2edce6)
added nyc for test coverage reporting. fix: add jsdoc comments (8b6e5cc)
added save record request model with tests (78f9be3)
added saveRecord method (757e773)
added sinon for stubbing in tests. fix: added jsdoc comments to enums. feat: begin working on implementing OnspringClient methods (f66edb0)
added tests for getFieldsByAppId implementation (d44782f)
added tests for getFileById method. fix: refactor getApiResponse and TryToGetMessage methods in ApiResponseFactory class to be able to return the proper string message when the responseType passed to axios was 'stream' (ee5aaf3)
begin adding endpoint factory methods and tests (b36d944)
begin implementing getReportsByAppId method (f0aeb51)
begin working on implementing record methods (fde8b50)
begin working on integration tests that will call actual onspring api sandbox (5de13d6)
begin working on lint_test_format workflow (dd16c4e)
begin writing files integration tests (85db929)
begin writing report integration tests (6175e8c)
begin writing tests for getAppsByIds method (d00683e)
completed methods for endpoint factory (4258793)
continuing to work on implementing records methods (6ba77ce)
finish implementing getRecordById method (0af3a9d)
finish implementing getReportsByAppId method (58de996)
finish writing integration tests for getApps (6adaaaa)
finish writing tests for getRecordsByIds method (abf571f)
implement addOrUpdateListItem method (190c829)
implement deleteFileById method (a68ea4f)
implement deleteListItemById method (48f62a8)
implement deleteRecordById method (708cf65)
implement getAppsByIds method (a38a624)
implement getFieldById method (a1d3683)
implement getFieldsByAppId method (59a12cb)
implement getFieldsByIds method (22ba452)
implement getFileById method (04e1ebd)
implement getRecordsByAppId method (75349b2)
implement getReportById method (3b3e210)
implement method to Record model to allow it to convert itself to a SaveRecordRequest (f07cd30)
implement queryRecords method (71ef5ff)
implement saveFile method (3dee5b6)
implemented getFileInfoById method (48de5ec)
introduce fixable lint error and formatting issue to test workflow (f531ade)
setup prettier (900cdfb)
stub out integration tests for record methods (818bd0d)
stub out integration tests for reports (6c8127f)

Assets 2