Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

@faustjs/core export and naming refactor #590

Closed
9 tasks done
wjohnsto opened this issue Oct 18, 2021 · 0 comments · Fixed by #601
Closed
9 tasks done

@faustjs/core export and naming refactor #590

wjohnsto opened this issue Oct 18, 2021 · 0 comments · Fixed by #601
Assignees
@wjohnsto
Labels
package: core (legacy) Related to the legacy core package type: feature New functionality being added

Comments

@wjohnsto
Copy link
Contributor

wjohnsto commented Oct 18, 2021 •
edited
Loading

None of these should result in breaking changes for all in-flight apps, but we do need to make a not of it in changesets.

  • Move all client-side auth functions into src/auth and export on @faustjs/core/auth namespace (see @faustjs/core/api namespace as an example)
  • Move all utils functions into src/utils and export on @faustjs/core/utils namespace (see @faustjs/core/api namespace as an example)
  • Move all client-side config functions into src/config and export on @faustjs/core/config namespace (see @faustjs/core/api namespace as an example)
  • Move all client-side gqty functions into src/gqty and export on @faustjs/core/client namespace (see @faustjs/core/api namespace as an example)
  • Ensure the @faustjs/core namespace only exports getClient and config functions and related interfaces
  • Remove schema.generated.ts
  • Change "Headless config" to "Faust config" in src/auth/client/accessToken.ts
  • src/config/config.ts mentions @memberof HeadlessConfig, should be @memberof Config
  • src/gqty/index.ts mentions @memberof HeadlessConfig, should be @memberof ClientConfig
@wjohnsto wjohnsto added the type: feature New functionality being added label Oct 18, 2021
@wjohnsto wjohnsto self-assigned this Oct 18, 2021
@wjohnsto wjohnsto added the package: core (legacy) Related to the legacy core package label Oct 18, 2021
wjohnsto added a commit that referenced this issue Oct 20, 2021
@wjohnsto
#590 exporting auth, moving all exports into export folder
f29071b
wjohnsto added a commit that referenced this issue Oct 20, 2021
@wjohnsto
#590 exporting utils
e65f762
wjohnsto added a commit that referenced this issue Oct 20, 2021
@wjohnsto
#590 exporting config
08684c6
wjohnsto added a commit that referenced this issue Oct 20, 2021
@wjohnsto
#590 exporting client
ac0baa6
wjohnsto added a commit that referenced this issue Oct 20, 2021
@wjohnsto
#590 removing most of schema.generated, exporting only getClient, con…
b38223f 
…fig, and related types
wjohnsto added a commit that referenced this issue Oct 20, 2021
@wjohnsto
#590 Headless -> Faust.js
5a403f2
wjohnsto added a commit that referenced this issue Oct 20, 2021
@wjohnsto
#590 HeadlessConfig -> Config
956485e
wjohnsto added a commit that referenced this issue Oct 20, 2021
@wjohnsto
#590 HeadlessConfig -> ClientConfig
c61a274
@wjohnsto wjohnsto mentioned this issue Oct 20, 2021
Merged
blakewilson pushed a commit that referenced this issue Oct 21, 2021
@wjohnsto
Core refactor (#601)
81d6162 
* #590 exporting auth, moving all exports into export folder

* #590 exporting utils

* #590 exporting config

* #590 exporting client

* #590 removing most of schema.generated, exporting only getClient, config, and related types

* #590 Headless -> Faust.js

* #590 HeadlessConfig -> Config

* #590 HeadlessConfig -> ClientConfig

* chore: changeset

* fix: core test imports

* chore: updating packages

* fix: only one failing test based on no exports support from jest 27

* fix: fixing tests, updating dependencies
blakewilson added a commit that referenced this issue Nov 5, 2021
@blakewilson @apmatthews
@wjohnsto @github-actions @narcher7
Fix main merge conflict in Deny Public Access Callback (#633)
953a767 
* refactor: simplify public route redirection by using template_redirect (#575)

* Update API Router `import` in Auth Docs (#580)

* doc: (#519) adding examples for getStaticPaths

* Update API Router auth import docs

* Update API Router imports to use `@faustjs/core/api`

Co-authored-by: William Johnston <[email protected]>

* chore: remove unused wp-env dependency

* chore: use Faust WP in comment text

* chore: set minimum PHP to 7.2

* refactor: text domain wpe-headless -> faustwp

* refactor: global consts WPE_HEADLESS -> FAUSTWP

* refactor: replace function prefixes with namespace

* refactor: settings slug to faustwp-settings

* refactor: local variable prefixes to faustwp

* refactor: filter prefixes wpe_headless -> faustwp

* refactor: script handle prefixes to faustwp

* refactor: id attribute prefix to faustwp

* refactor: REST API namespace wpac -> faustwp

* style: phpcs

* Revert "refactor: REST API namespace wpac -> faustwp"

This reverts commit 30d4488.

* chore: add license file and plugin headers

* style: change Faust WP to FaustWP

* fix: remove redirect to settings on activation (#595)

* Setup GitHub Actions for Testing/Linting Plugin (#582)

* Lint plugin

* Run unit tests via docker/github actions

* Use -T in docker-compose

* Use docker command instead of docker compose

* Remove interactive tty

* List files in dir

* Simplify docker from

* Fix wp-cli

* Use wp cli from run step

* Run unit test on windows

* Test docker unit tests with macos

* Remove volume from docker compose

* inspect container

* Add working-directory to inspect step

* Use entrypoint/cmd

* Sleep for 30 secs

* Link db

* Try simplifying testing env

* Use more verbose phpunit command

* Check current dir

* Composer install

* Clean up test action

* Set sleep to 15 seconds

* Fix CircleCI test

* Update documentation

* Update action names

* chore: update plugin URI (#596)

* refactor: Remove CircleCI Config (#597)

* Update plugin file and folder name to faustwp (#600)

* chore: delete unused wp-env config

* chore: prepare for plugin file/folder rename

* refactor: plugin file/folder name to faustwp

* chore: update WPE Headless to FaustWP

* test: update e2e test db

* Core refactor (#601)

* #590 exporting auth, moving all exports into export folder

* #590 exporting utils

* #590 exporting config

* #590 exporting client

* #590 removing most of schema.generated, exporting only getClient, config, and related types

* #590 Headless -> Faust.js

* #590 HeadlessConfig -> Config

* #590 HeadlessConfig -> ClientConfig

* chore: changeset

* fix: core test imports

* chore: updating packages

* fix: only one failing test based on no exports support from jest 27

* fix: fixing tests, updating dependencies

* Create E2E action (#599)

* Create E2E action

* Setup PHP and Node

* Ensure frontend process doesn't hang

* Don't use docker compose in exec scripts

* Add sleep for DB to accept connections

* Add working directory to setup tests step

* Use Allow root wp cli

* Setup chrome

* Fix chrome version step syntax

* Chrome/ChromeDriver is already installed on action

* Add chrome driver args for GH Actions

* e2e Click preview link and determine if correct preview page is fetched

* Revert preview link href assertion removal

* Wait for previewlinks.js to modify button href before checking preview link

* fix: headless post previews URL (#602)

* Version Packages (#603)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* chore: start unreleased changelog for FaustWP (#604)

* chore: Upload test artifact upon failure (#606)

* chore: Upload test artifact upon failure

* fix: increase wait time for preview test to 14 seconds

* Rename settings option to faustwp_settings (#607)

* refactor: rename settings option to faustwp_settings

* feat: add database upgrade functions

* Release `faustwp` plugin action (#608)

* feat: create wordpress.org deploy GH action

* docs: reflect new release steps

* chore: add dist ignore for plugin release

* chore: copy 10up action src

* refactor: option to specify plugin src dir

* refactor: use release-pugin local action

* fix: e2e plugin npm deps install (#609)

* fix: NPM deps install

* Squashed commit of the following:

commit 40d08d0
Author: William Johnston <[email protected]>
Date:   Fri Oct 22 13:47:00 2021 -0700

    fix: exporting components from declaration

commit 145ef99
Merge: 632a57f 4d7f981
Author: William Johnston <[email protected]>
Date:   Fri Oct 22 10:46:13 2021 -0700

    Merge branch 'canary' into next-refactor

commit 632a57f
Author: William Johnston <[email protected]>
Date:   Fri Oct 22 10:05:38 2021 -0700

    feat: (#591) adding changeset denoting breaking change

commit 7f2a760
Author: William Johnston <[email protected]>
Date:   Fri Oct 22 09:55:23 2021 -0700

    feat: (#591) limiting root @faustjs/next exports to those needed by client

commit b1ba602
Author: William Johnston <[email protected]>
Date:   Fri Oct 22 09:48:03 2021 -0700

    feat: (#591) creating @faustjs/next/components export

commit e4ad3ea
Author: William Johnston <[email protected]>
Date:   Fri Oct 22 09:46:28 2021 -0700

    feat: (#591) creating @faustjs/next/server export

commit 69b6321
Author: William Johnston <[email protected]>
Date:   Fri Oct 22 09:43:46 2021 -0700

    feat: (#591) creating @faustjs/next/log export

commit 9be7e1d
Author: William Johnston <[email protected]>
Date:   Fri Oct 22 09:41:23 2021 -0700

    feat: (#591) creating @faustjs/next/config export

commit 664bb90
Author: William Johnston <[email protected]>
Date:   Fri Oct 22 09:38:01 2021 -0700

    feat: (#591) creating @faustjs/next/utils export

commit 38888e8
Author: William Johnston <[email protected]>
Date:   Fri Oct 22 09:36:51 2021 -0700

    feat: (#591) migrating to src/gqty and exposing @faustjs/next/client

* fix: add build step

* refactor: use dev:next:getting-started command

* Revert "Squashed commit of the following:"

This reverts commit d15356f.

* Next refactor (#605)

* feat: (#591) migrating to src/gqty and exposing @faustjs/next/client

* feat: (#591) creating @faustjs/next/utils export

* feat: (#591) creating @faustjs/next/config export

* feat: (#591) creating @faustjs/next/log export

* feat: (#591) creating @faustjs/next/server export

* feat: (#591) creating @faustjs/next/components export

* feat: (#591) limiting root @faustjs/next exports to those needed by client

* feat: (#591) adding changeset denoting breaking change

* fix: exporting components from declaration

Co-authored-by: Blake Wilson <[email protected]>

* Version Packages (#613)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* chore: remove react example (#618)

* docs: update tutorial sidebar label (#620)

* Grammar Dev Env Setup (#630)

* Grammar edits to basic headless site (#629)

* Breakout Hooks Docs into Seperate Pages (#632)

* doc: (#519) adding examples for getStaticPaths

* Update API Router auth import docs

* Update API Router imports to use `@faustjs/core/api`

* Breakout Hooks into individual Pages (#631)

* docs: break out hooks

* Update links to appropriate hooks url

* Logging queries guide

* Fix docs site URLs

* Fix hooks links

Co-authored-by: William Johnston <[email protected]>

Co-authored-by: Andrew Matthews <[email protected]>
Co-authored-by: William Johnston <[email protected]>
Co-authored-by: Will Johnston <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Nate Archer <[email protected]>
blakewilson added a commit that referenced this issue Nov 5, 2021
@blakewilson @apmatthews
@wjohnsto @github-actions @narcher7
Deploy latest site changes to prod (#627)
b9f9c34 
* refactor: simplify public route redirection by using template_redirect (#575)

* Update API Router `import` in Auth Docs (#580)

* doc: (#519) adding examples for getStaticPaths

* Update API Router auth import docs

* Update API Router imports to use `@faustjs/core/api`

Co-authored-by: William Johnston <[email protected]>

* chore: remove unused wp-env dependency

* chore: use Faust WP in comment text

* chore: set minimum PHP to 7.2

* refactor: text domain wpe-headless -> faustwp

* refactor: global consts WPE_HEADLESS -> FAUSTWP

* refactor: replace function prefixes with namespace

* refactor: settings slug to faustwp-settings

* refactor: local variable prefixes to faustwp

* refactor: filter prefixes wpe_headless -> faustwp

* refactor: script handle prefixes to faustwp

* refactor: id attribute prefix to faustwp

* refactor: REST API namespace wpac -> faustwp

* style: phpcs

* Revert "refactor: REST API namespace wpac -> faustwp"

This reverts commit 30d4488.

* chore: add license file and plugin headers

* style: change Faust WP to FaustWP

* fix: remove redirect to settings on activation (#595)

* Setup GitHub Actions for Testing/Linting Plugin (#582)

* Lint plugin

* Run unit tests via docker/github actions

* Use -T in docker-compose

* Use docker command instead of docker compose

* Remove interactive tty

* List files in dir

* Simplify docker from

* Fix wp-cli

* Use wp cli from run step

* Run unit test on windows

* Test docker unit tests with macos

* Remove volume from docker compose

* inspect container

* Add working-directory to inspect step

* Use entrypoint/cmd

* Sleep for 30 secs

* Link db

* Try simplifying testing env

* Use more verbose phpunit command

* Check current dir

* Composer install

* Clean up test action

* Set sleep to 15 seconds

* Fix CircleCI test

* Update documentation

* Update action names

* chore: update plugin URI (#596)

* refactor: Remove CircleCI Config (#597)

* Update plugin file and folder name to faustwp (#600)

* chore: delete unused wp-env config

* chore: prepare for plugin file/folder rename

* refactor: plugin file/folder name to faustwp

* chore: update WPE Headless to FaustWP

* test: update e2e test db

* Core refactor (#601)

* #590 exporting auth, moving all exports into export folder

* #590 exporting utils

* #590 exporting config

* #590 exporting client

* #590 removing most of schema.generated, exporting only getClient, config, and related types

* #590 Headless -> Faust.js

* #590 HeadlessConfig -> Config

* #590 HeadlessConfig -> ClientConfig

* chore: changeset

* fix: core test imports

* chore: updating packages

* fix: only one failing test based on no exports support from jest 27

* fix: fixing tests, updating dependencies

* Create E2E action (#599)

* Create E2E action

* Setup PHP and Node

* Ensure frontend process doesn't hang

* Don't use docker compose in exec scripts

* Add sleep for DB to accept connections

* Add working directory to setup tests step

* Use Allow root wp cli

* Setup chrome

* Fix chrome version step syntax

* Chrome/ChromeDriver is already installed on action

* Add chrome driver args for GH Actions

* e2e Click preview link and determine if correct preview page is fetched

* Revert preview link href assertion removal

* Wait for previewlinks.js to modify button href before checking preview link

* fix: headless post previews URL (#602)

* Version Packages (#603)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* chore: start unreleased changelog for FaustWP (#604)

* chore: Upload test artifact upon failure (#606)

* chore: Upload test artifact upon failure

* fix: increase wait time for preview test to 14 seconds

* Rename settings option to faustwp_settings (#607)

* refactor: rename settings option to faustwp_settings

* feat: add database upgrade functions

* Release `faustwp` plugin action (#608)

* feat: create wordpress.org deploy GH action

* docs: reflect new release steps

* chore: add dist ignore for plugin release

* chore: copy 10up action src

* refactor: option to specify plugin src dir

* refactor: use release-pugin local action

* fix: e2e plugin npm deps install (#609)

* fix: NPM deps install

* Squashed commit of the following:

commit 40d08d0
Author: William Johnston <[email protected]>
Date:   Fri Oct 22 13:47:00 2021 -0700

    fix: exporting components from declaration

commit 145ef99
Merge: 632a57f 4d7f981
Author: William Johnston <[email protected]>
Date:   Fri Oct 22 10:46:13 2021 -0700

    Merge branch 'canary' into next-refactor

commit 632a57f
Author: William Johnston <[email protected]>
Date:   Fri Oct 22 10:05:38 2021 -0700

    feat: (#591) adding changeset denoting breaking change

commit 7f2a760
Author: William Johnston <[email protected]>
Date:   Fri Oct 22 09:55:23 2021 -0700

    feat: (#591) limiting root @faustjs/next exports to those needed by client

commit b1ba602
Author: William Johnston <[email protected]>
Date:   Fri Oct 22 09:48:03 2021 -0700

    feat: (#591) creating @faustjs/next/components export

commit e4ad3ea
Author: William Johnston <[email protected]>
Date:   Fri Oct 22 09:46:28 2021 -0700

    feat: (#591) creating @faustjs/next/server export

commit 69b6321
Author: William Johnston <[email protected]>
Date:   Fri Oct 22 09:43:46 2021 -0700

    feat: (#591) creating @faustjs/next/log export

commit 9be7e1d
Author: William Johnston <[email protected]>
Date:   Fri Oct 22 09:41:23 2021 -0700

    feat: (#591) creating @faustjs/next/config export

commit 664bb90
Author: William Johnston <[email protected]>
Date:   Fri Oct 22 09:38:01 2021 -0700

    feat: (#591) creating @faustjs/next/utils export

commit 38888e8
Author: William Johnston <[email protected]>
Date:   Fri Oct 22 09:36:51 2021 -0700

    feat: (#591) migrating to src/gqty and exposing @faustjs/next/client

* fix: add build step

* refactor: use dev:next:getting-started command

* Revert "Squashed commit of the following:"

This reverts commit d15356f.

* Next refactor (#605)

* feat: (#591) migrating to src/gqty and exposing @faustjs/next/client

* feat: (#591) creating @faustjs/next/utils export

* feat: (#591) creating @faustjs/next/config export

* feat: (#591) creating @faustjs/next/log export

* feat: (#591) creating @faustjs/next/server export

* feat: (#591) creating @faustjs/next/components export

* feat: (#591) limiting root @faustjs/next exports to those needed by client

* feat: (#591) adding changeset denoting breaking change

* fix: exporting components from declaration

Co-authored-by: Blake Wilson <[email protected]>

* Version Packages (#613)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* chore: remove react example (#618)

* docs: update tutorial sidebar label (#620)

* Grammar Dev Env Setup (#630)

* Grammar edits to basic headless site (#629)

* Breakout Hooks Docs into Seperate Pages (#632)

* doc: (#519) adding examples for getStaticPaths

* Update API Router auth import docs

* Update API Router imports to use `@faustjs/core/api`

* Breakout Hooks into individual Pages (#631)

* docs: break out hooks

* Update links to appropriate hooks url

* Logging queries guide

* Fix docs site URLs

* Fix hooks links

Co-authored-by: William Johnston <[email protected]>

Co-authored-by: Andrew Matthews <[email protected]>
Co-authored-by: William Johnston <[email protected]>
Co-authored-by: Will Johnston <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Nate Archer <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@wjohnsto wjohnsto

Labels
package: core (legacy) Related to the legacy core package type: feature New functionality being added
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Core refactor wpengine/faustjs
1 participant
@wjohnsto