Skip to content

Latest commit

 

History

History
188 lines (117 loc) · 6.15 KB

CHANGELOG.md

File metadata and controls

188 lines (117 loc) · 6.15 KB
Raw

Changelog

v0.3.5

0.3.5 (2024-03-19)

  • feat: add support for modular models metadata

v0.3.4

0.3.4 (2024-03-15)

v0.3.3

0.3.3 (2024-02-26)

  • fix: do not call ReadAuthorizationModel on BatchCheck or non-Transactional Write

v0.3.2

0.3.2 (2024-02-13)

  • feat: add example project
  • feat: add support for apiUrl configuration option and deprecate apiScheme and apiHost
  • fix: use correct content type for token request
  • fix: make body in readChanges optional

v0.3.1

0.3.1 (2024-01-26)

  • chore: use latest API interfaces
  • chore: dependency updates

v0.3.0

0.3.0 (2023-12-11)

  • feat: support for conditions
  • chore: use latest API interfaces
  • chore: dependency updates

v0.2.10

0.2.10 (2023-11-01)

v0.2.9

0.2.9 (2023-10-20)

  • chore(deps): update dependencies

v0.2.8

0.2.8 (2023-08-18)

  • fix: set http keep-alive to true
  • fix: list relations should throw when an underlying check errors
  • fix: return raw response in client check
  • chore(deps): update dependencies

v0.2.7

0.2.7 (2023-08-16)

  • fix(credentials): fix calculation of token expiry
  • chore(deps): update dependencies

v0.2.6

0.2.6 (2023-05-19)

  • feat(validation): ensure storeId and authorizationModelId are in valid ulid format
  • fix(client): ensure that the api connection is valid
  • fix(credentials): retry on client credential exchange in case of errors
  • chore(deps): update dependencies

v0.2.5

0.2.5 (2023-04-21)

  • feat(client): implement listRelations to check what relationships a user has with an object
  • feat!: schema_version is now required when calling WriteAuthorizationModel
  • fix(client): proper parallel limit for batch fns (BatchCheck, etc..)
  • chore(ci): publish provenance data
  • chore(deps): update dependencies

v0.2.4

0.2.4 (2023-03-09)

  • fix(client): OpenFgaClient read was not passing in pagination options
  • feat(client): implement sleep in batch calls to lower the possibility of hitting rate limits

v0.2.3

0.2.3 (2023-03-07)

  • feat(client): client wrapper with a slightly changed interface
  • feat(client): implement batchCheck to check multiple tuples in parallel
  • feat(client): add support for a non-transactional Write
  • chore(config): bump default max retries to 5
  • fix: retry on 5xx errors
  • chore!: request Node >= 14.7.0

Checkout the README for more on how to use the new OpenFgaClient.

v0.2.2

0.2.2 (2023-01-23)

  • fix(credentials): resolve client credentials token not being cached
  • chore(deps): upgrade dev dependencies

v0.2.1

0.2.1 (2023-01-17)

  • chore(deps): upgrade dev dependencies, resolves npm audit issue

v0.2.0

0.2.0 (2022-12-14)

Updated to include support for OpenFGA 0.3.0

Changes:

  • [BREAKING] feat(list-objects)!: response has been changed to include the object type e.g. response that was {"object_ids":["roadmap"]}, will now be {"objects":["document:roadmap"]}

Fixes:

  • fix(models): update interfaces that had incorrectly optional fields to make them required

Chore:

  • chore(deps): update dev dependencies

v0.1.1

0.1.1 (2022-11-15)

Regenerate to include support for restricting wildcards in authorization models.

v0.1.0

0.1.0 (2022-09-29)

  • BREAKING: exported type TypeDefinitions is now WriteAuthorizationModelRequest This is only a breaking change on the SDK, not the API. It was changed to conform to the proto changes in openfga/api. It makes the type name more consistent and less confusing (normally people would incorrectly assume TypeDefinitions = TypeDefinition[]).
  • chore(deps): upgrade dependencies

v0.0.2

0.0.2 (2022-08-15)

Support for [ListObjects API]](https://openfga.dev/api/service#/Relationship%20Queries/ListObjects)

You call the API and receive the list of object ids from a particular type that the user has a certain relation with.

For example, to find the list of documents that Anne can read:

const response = await openFgaApi.listObjects({
  user: "anne",
  relation: "can_read",
  type: "document"
});

// response.object_ids = ["roadmap"]

v0.0.1

0.0.1 (2022-06-15)

Initial OpenFGA JS SDK release

  • Support for OpenFGA API
    • CRUD stores
    • Create, read & list authorization models
    • Writing and Reading Tuples
    • Checking authorization
    • Using Expand to understand why access was granted