Skip to content

Latest commit

 

History

History
355 lines (166 loc) · 21.1 KB

CHANGELOG.md

File metadata and controls

355 lines (166 loc) · 21.1 KB
Raw

2.3.2 (2021-10-08)

Bug Fixes

  • Paging was not working due to invalid URL created for additional pages. (36d6b2c)
  • Response debug logging refers to request variables, which is both wrong AND confusing. (bed3966)

2.3.1 (2021-10-06)

Bug Fixes

  • Can only enable one debugger at a time, which isn't useful. (b91a187)
  • Fetching cards by sequentialId fails due to incorrectly parsing the provided ID. (9005682)

2.3.0 (2021-10-06)

Features

  • Allow enabling/disabling debug logging via BravoClient methods, allowing finer control over what gets logged. (f670267)

2.2.0 (2021-10-06)

Features

  • Add NODE_DEBUG-style logging to Favro API requests, allowing devs to opt into a ton of info for triangulating request issues. (04e047f)

2.1.2 (2021-10-06)

Bug Fixes

  • Card searches can use the 'cardSequentialId' as a search param, but that value can be provided in multiple formats and the Favro API doesn't always play nice. The value should be normalized to the numeric identifier. (c2d6db0)

2.1.1 (2021-10-05)

Features

  • Improve handling of rate limit monitoring, since it doesn't (bc72c29)

2.1.0 (2021-10-04)

Features

  • Add client and BravoGroup methods for creating, updating, and deleting Groups, with tests. (c2dd9f3)

2.0.2 (2021-10-04)

2.0.1 (2021-10-02)

Bug Fixes

  • The types used by the Card Update builder are broken for array fields, resulting in everything being the 'any' type. (c140250)

2.0.0 (2021-10-01)

Features

  • Change the method for finding cards by sequential ID to return an already-awaited list, and to allow limiting to one returned value. BREAKING (ea565df)

1.8.1 (2021-09-27)

Bug Fixes

  • Requests with 'undefined' values in query params send 'undefined' as a string, breaking some requests. (7e69623)

1.8.0 (2021-09-27)

Features

  • Allow for custom Error classes and logging utilities to be used by BravoClient instances. (fe06ceb)

1.7.0 (2021-09-27)

Features

  • Add overload to allow finding a column given only its ID, for cases where we have that but not the Widget the column comes from. (0e1681b)

1.6.0 (2021-09-27)

Features

  • Change the listGroups method to return an already-fully-listed array, since there aren't likely to be a ton of groups in an org. (959c110)

1.5.0 (2021-09-27)

Features

  • Add methods for listing and finding member Groups. (b2da2d0)

1.4.0 (2021-09-23)

Features

  • Allow new webhooks to be created with automatic secret generation. (372ae73)

1.3.0 (2021-09-23)

Features

  • Add a BravoWebhook class, with corresponding methods and tests. (dfa64f6)
  • Add export of BravoEntity types in the entryfile, so that they're more accessible. (ab834c1)

1.2.0 (2021-09-18)

Features

  • Allow using a custom node-fetch-compatible module for making requests. (f6034e9)

1.1.0 (2021-08-30)

Features

  • Add Comment types to the FavroApi typings. (6d808ed)
  • Add full Webhook typings. (8c77de3)

1.0.2 (2021-08-29)

1.0.1 (2021-08-29)

Bug Fixes

  • The FavroApi typings import paths are being exported incorrectly, breaking types in the build. (4cb3734)

1.0.0 (2021-08-29)

Features

  • Completely redo all Favro Api types into the FavroApi namespace. (076f992)

0.9.0 (2021-08-29)

Features

  • Continue reorganizting and renaming Favro API data types into namespaced structures. (e28bad5)
  • Reorganize and rename core Favro API typings using namespaces to keep things from polluting global scope. BREAKING (a08beb5)
  • Reorganize Column typings into the FavroApi namespace. BREAKING (eaa0a43)
  • Restructure Widget types into the new namespaced FavroApi typings. BREAKING (ff78d1a)

0.8.0 (2021-08-28)

Features

  • Add new importsNotUsedAsValues field to tsconfig to make it easy to catch imports that should be type-imports, and fix all discovered errors. (84f07d6)
  • Add Tag management methods to the Client and improve related methods on Cards. BREAKING (4f364e5)

0.7.0 (2021-08-28)

Features

  • Add methods for setting Custom Members fields. (24af17d)

0.6.0 (2021-08-27)

Features

  • Add setter methods for Custom Multiple Select fields. Also rename Single Select methods. BREAKING (30cd60b)

0.5.0 (2021-08-26)

Bug Fixes

  • Setting and checking Custom Status ('Single Select') fields yields errors. (d34b2b6)
  • The caching mechanism for searching an entity response array by ID is storing the wrong values. (223ad66)

Features

  • Add Custom Field setters for Text, Votes, Ratings, Numbers, (e854e97)
  • Add methods for all common-field upates to Card instances. (0e51f9b)
  • Add methods to simplify allowing other method arguments to be supplied as class instances or raw strings. (a14ee8e)
  • Allow Card UpdateBuilder methods that update user-related fields to use BravoUser objects or userId strings. (7fff8a3)
  • Change the UpdateBuilder to be explicitly used for updates instead of as a side effect. BREAKING (91fb2a0)

0.4.0 (2021-08-22)

Features

  • Change the name of the method for finding a card by its cardId to be more precise. (0e81a9b)

0.3.0 (2021-08-22)

Features

  • Add Card methods for fetching associated Custom Field definitions and values. (de0188d)
  • Add Client method to find a Custom Field by its ID. (631630e)

0.2.0 (2021-08-21)

Bug Fixes

  • The Custom Fields cache is not being cleared during full-cache clear. (16eed35)

Features

  • Add general 'findCollection' method to Client (01b1537)
  • Add method to Card instances for fetching associated Custom Field definitions. (24a3087)
  • Add methods to Cards for getting and setting their Column/Status. (4821578)
  • Change method names for finding organization users, and create aliases in Organization classes. BREAKING (c84ba50)
  • Remove member-finding aliases from Org instances and simplify the names of said methods in the Client. BREAKING (b3e8a0f)
  • Rename card methods to refer to Card 'Instances' to be more explicit about what's happening. (a5aa22e)
  • Require including organizationId when instancing a BravoClient. Allowing setting it later by name makes many things confusing and weird. BREAKING (e566707)
  • Update all dependencies and ensure tests pass. (06a9e78)

0.1.0 (2021-08-19)

Bug Fixes

  • An unsaved refactor breaks a method. (714cc1d)
  • Remove legacy function overloads for generic Favro requests. (ae464db)
  • Resolve type discrepancies between docs and sample Card data. (80b9743)
  • The body of a request is being parsed from the whole request options object instead of just the body field. (7931b1f)
  • The Favro Card Update type does not include null as an option for date fields. (fb9431b)
  • The test configuration in launch.json points to a non-existent test file. (22c268f)
  • The update builder is not reset after running an update. (cb74e1b)

Features

  • Add a helper class to make building Favro Card updates easier, plus a method on a BravoCard to update itself using that class or raw data. (008f7c5)
  • Add a listCollections method and requisite caching. (65c2126)
  • Add a method to list widgets (obtaining a pageable result). (d9117d7)
  • Add a utility type for array-matching functions. (e427ba2)
  • Add caching to Widget Columns. (956dcd7)
  • Add Card class. (5133cb4)
  • Add client methods for fetching, creating, and delting Columns. (8a6d604)
  • Add column-related partial methods to Widgets and Columns. (42001de)
  • Add draft Card types. (4ba0de9)
  • Add draft Column types. (d0dd315)
  • Add draft Custom Field types (special thanks to regex). (b93b06e)
  • Add draft Tag types. (65f1f58)
  • Add draft type for the body content of a Card update. (f986af1)
  • Add fetching and caching of custom fields. (6a29180)
  • Add find/delete methods for columns in Widget instances. (3bd307c)
  • Add finding cards by their sequentialId (the number shown on the Favro UI on cards). (621dc8a)
  • Add generic client method for finding widget columns. (2d87d1e)
  • Add ignore-case option to the general finder function, and use for finding by name or email. (b177680)
  • Add method for fetching a specific card by its cardId. (561d6a7)
  • Add method for updating a Card with a raw data structure (no helpers for Custom Fields). (0493403)
  • Add method to find users by name, id, or email. (02e79c3)
  • Add methods for creating and deleting Collections, add more classes and types for the disparate kinds of API response data, and improve generic request handling. (65c49ed)
  • Add methods for creating, finding, and deleting cards, with passing tests. (e5bed0c)
  • Add methods to find collections by name or ID. (fd13627)
  • Add partial methods to the Collection class to allow instances to find their own Widgets. (8b1883c)
  • Add types for Card creation and searching. (82e3e7b)
  • Add utility 'find' functions for improved typing and more specific functionality for class 'find' methods. (344f288)
  • Add Widget deletion methods and get all tests passing. (1c2898a)
  • Change basic info in the template CLI scripts (nowhere near functional still). (d12bab0)
  • Change finding/deleting Collections by name to be batch methods, since names are not unique in Favro. (08d8647)
  • Change the find-collection-by-id method to directly hit the single-collection API endpoint if not found in cache. (53a1a25)
  • Complete types for updating a Card. (47dbdd9)
  • Create a distinct BravoResponse class that can page and hydrate results. (4ebf40a)
  • Draft base BravoClient class, including a method for general Favro API requests and a wrapper class for returned results. (2d90d6b)
  • Draft content for dealing with an Integromat Favro app. (077d9e2)
  • Draft the Column class. (b2318a7)
  • Get all built-in fields updateable with all tests passing. (b7582ea)
  • Have all API data wrapped in a class extending a base 'FavroEntity' class, with access to the client. (546cc98)
  • Have card instances produce user-friendly URLs for linking to cards via the Favro app. (aeda35d)
  • Implement methods for listing orgs, setting the current org, and listing org users. (6f59b1e)
  • Implement uploading card attachments. (d2319af)
  • Move core Favro API functionality into a base 'FavroClient' class to reduce complexity. (992524a)
  • Prevent the organizationId from being reset once set, since that will complicate literally everything downstream. (5e3de6d)
  • Rename classes to be more consistent between use of 'Bravo' vs. 'Favro' (6d34319)
  • Simplify API for Favro response parsing by using async iterators, and add find methods for Widgets. (111bf17)