refactor!: access settings through setters and getters

[luqven]

Description

This PR demonstrates how we could refactor js-core to use setters/getters to allow us to read and modify this.settings at any time during the object's lifecycle.

The proposal is to add a get and set object property binding to each settings we'd like to be able to modify outside the constructor.

// we'd like to be able to do this
const client = new ImgixClient({domain: 'test.imgix.net'})
client.domain = 'sdk-test.imgix.net`

// so in the class we do something like this
export default class ImgixClient {
  constructor(opts = {}) {
    this._settings = { ...DEFAULT_OPTIONS, ...opts };
    // ...
  }

  get domain() {
    return this._settings.domain;
  }

  set domain(value) {
    if (typeof value != 'string') {
      throw new Error('ImgixClient must be passed a valid string domain');
    }

    if (DOMAIN_REGEX.exec(value) == null) {
      throw new Error(
        'Domain must be passed in as fully-qualified ' +
          'domain name and should not include a protocol or any path ' +
          'element, i.e. "example.imgix.net".',
      );
    }
    this._settings.domain = value;
  }

Note: the properties set using the getters/setters will be set on the prototype of the class and not the instance.

Before this PR

You could not change certain settings, ie libraryParam outside of the constructor without running into issues where this.settings was not in sync with this.libraryParam.

After

You can set includeLIbraryParam ~and libraryParam~ using a setter.

Checklist

• [x] All existing unit tests are still passing (if applicable).
• [ ] Update the README.md with relevant changes.
• [x] Add new passing unit tests to cover the code introduced by your PR (if applicable).
• [x] Any breaking changes are specified on the commit on which they are introduced with BREAKING CHANGE in the body of the commit.

[commit-lint[bot]]

Code Refactoring

• access settings through setters and getters (e0ef180)
• use validators in getters and setters (b027d60)
• underscore library-param setter (b421013)

Tests

• add test for turning off includeLibraryParam (c766c3f)
• add settings setters test (5eb022f)
• update setter test to use-https (d917476)
• add test to ensure settings cannot be reassigned (c83e20d)
• use underscore in test to set library param (70e9310)

Features

• add imgix-client-options-type (7b3f11c)
• allow url token to be undefined (13c97df)
• create settings validators (ae8eb85)
• add readonly types (856e086)
• use get & set type declarations (9e66f8d)

Chore

• remove console log (92f4b9f)
• remove readonly from types (83e0c59)
• fix spelling (2823ba9)
• fix typo in jsdoc (3d74629)
• removed unecessary conditional (8c25305)

Contributors

luqven

Commit-Lint commands

You can trigger Commit-Lint actions by commenting on this PR: - `@Commit-Lint merge patch` will merge dependabot PR on "patch" versions (X.X.Y - Y change) - `@Commit-Lint merge minor` will merge dependabot PR on "minor" versions (X.Y.Y - Y change) - `@Commit-Lint merge major` will merge dependabot PR on "major" versions (Y.Y.Y - Y change) - `@Commit-Lint merge disable` will desactivate merge dependabot PR - `@Commit-Lint review` will approve dependabot PR - `@Commit-Lint stop review` will stop approve dependabot PR

[luqven]

Closing this as it's gone stale. We wiill revisit it some other time.