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.

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

meta: deprecate @urbit/api #3

Merged
merged 1 commit into from
May 23, 2023
Merged

meta: deprecate @urbit/api #3

merged 1 commit into from
May 23, 2023

Conversation

tomholford
Copy link
Contributor

@tomholford tomholford commented May 19, 2023

This is a tangential task to an ongoing effort to implement Userspace Permissions UI (tloncorp/landscape#182)

As a prerequisite for UP: the npm SDK which frontend developers use for integrating with Landscape APIs needs to be updated with interfaces for the new pokes and scries.

Previously, this would be @urbit/api. However, per this PR the package is now deprecated: urbit/urbit#6232

Tlon has long had plans to release a successor to Indigo 1. The vision at this point is to create a new @tloncorp/gear package which will provide types for integrating with Landscape, as well as a component library and useful hooks for querying and managing state.

So why this PR: Since the new package will not have the Webterm types and utility functions, will migrate them from the deprecated package to this repo (See: tloncorp/landscape#176)

See: #176

This is a tangential task to an ongoing effort to implement Userspace Permissions UI (#182)

As a prerequisite for UP: the npm SDK which frontend developers use for integrating with Landscape APIs needs to be updated with interfaces for the new pokes and scries.

Previously, this would be `@urbit/api`. However, per this PR the package is now deprecated:
tloncorp/landscape#176

Tlon has long had plans to release a successor to Indigo 1. The vision at this point is to create a new `@tloncorp/gear` package which will provide types for integrating with Landscape, as well as a component library and useful hooks for querying and managing state.

So why this PR: Since the new package will not have the Webterm types and utility functions, I'm migrating them from the deprecated package to this repo.
@tomholford tomholford marked this pull request as ready for review May 19, 2023 20:09
@tomholford tomholford requested review from Fang- and arthyn May 19, 2023 20:09
Copy link
Contributor

@arthyn arthyn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, may want to double check @urbit/aura has a peer dep of big-integer that I don't see here

@tomholford
Copy link
Contributor Author

Confirmed that npm does not detect any missing peer deps:

If you want to check for missing peer dependencies manually, you can use the npm ls command. This will print out your dependency tree along with any issues it detects, including missing peer dependencies.

╰─$ npm ls
webterm@1.1.1 ~/dev/urbit/webterm/ui
├── @babel/core@7.20.12
├── @babel/plugin-proposal-class-properties@7.14.5
├── @babel/plugin-proposal-object-rest-spread@7.15.6
├── @babel/plugin-proposal-optional-chaining@7.14.5
├── @babel/plugin-transform-runtime@7.15.0
├── @babel/preset-env@7.15.6
├── @babel/preset-react@7.14.5
├── @babel/preset-typescript@7.15.0
├── @babel/runtime@7.20.13
├── @reach/menu-button@0.10.5
├── @tlon/indigo-react@1.2.25
├── @types/react-dom@16.9.14
├── @types/react-router-dom@5.1.8
├── @types/react@16.14.15
├── @types/styled-components@5.1.14
├── @types/styled-system@5.1.13
├── @typescript-eslint/eslint-plugin@4.31.1
├── @typescript-eslint/parser@4.31.1
├── @urbit/aura@1.0.0
├── @urbit/eslint-config@1.0.3
├── @urbit/http-api@2.3.0
├── @urbit/vite-plugin-urbit@0.8.0
├── @vitejs/plugin-react-refresh@1.3.6
├── @welldone-software/why-did-you-render@6.2.1
├── babel-eslint@10.1.0
├── babel-jest@26.6.3
├── babel-loader@8.2.2
├── babel-plugin-lodash@3.3.4
├── babel-plugin-root-import@6.6.0
├── browser-cookies@1.2.0
├── clean-webpack-plugin@3.0.0
├── cross-env@7.0.3
├── css-loader@3.6.0
├── eslint-import-resolver-typescript@2.5.0
├── eslint-plugin-import@2.25.4
├── eslint-plugin-react-hooks@4.3.0
├── eslint@7.32.0
├── file-loader@6.2.0
├── file-saver@2.0.5
├── html-webpack-plugin@4.5.2
├── husky@6.0.0
├── immer@10.0.2
├── jest@26.6.3
├── lint-staged@11.1.2
├── lodash@4.17.21
├── moment-locales-webpack-plugin@1.2.0
├── react-dom@16.14.0
├── react-hot-loader@4.13.0
├── react-router-dom@5.3.0
├── react@16.14.0
├── rollup-plugin-analyzer@4.0.0
├── rollup-plugin-visualizer@5.9.0
├── sass-loader@8.0.2
├── sass@1.58.2
├── style-loader@1.3.0
├── styled-components@5.3.1
├── styled-system@5.1.5
├── typescript@4.4.3
├── vite-plugin-html@3.2.0
├── vite@2.9.15
├── webpack-cli@3.3.12
├── webpack-dev-server@3.11.3
├── webpack@4.46.0
├── xterm-addon-fit@0.5.0
├── xterm@4.15.0
└── zustand@3.5.10

@tomholford tomholford merged commit c9d9228 into master May 23, 2023
@tomholford tomholford deleted the th/deprecate-urbit-api branch May 23, 2023 01:43
tomholford added a commit to tloncorp/landscape that referenced this pull request May 23, 2023
- copied lib and types from @urbit/api repo to gear/
- migrated webterm types (see: urbit/webterm#3)
- rename S3 --> Storage
tomholford added a commit to tloncorp/landscape that referenced this pull request May 25, 2023
- copied lib and types from @urbit/api repo to gear/
- migrated webterm types (see: urbit/webterm#3)
- rename S3 --> Storage
tomholford added a commit to tloncorp/landscape that referenced this pull request May 25, 2023
- copied lib and types from @urbit/api repo to gear/
- migrated webterm types (see: urbit/webterm#3)
- rename S3 --> Storage
tomholford added a commit to tloncorp/landscape that referenced this pull request Jun 7, 2023
- copied lib and types from @urbit/api repo to gear/
- migrated webterm types (see: urbit/webterm#3)
- rename S3 --> Storage
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants