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

feat: Init #1

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: Init #1

wants to merge 4 commits into from

Conversation

Chickensoupwithrice
Copy link
Contributor

Pulling out the API into it's own repo. This commit largely stolen from Ilya, added a couple other additional api calls

Going to add the load-test.js script in https://github.com/webrecorder/browsertrix-cloud that uses this client. Testing that with yarn link

At some point we may wish to publish this to npm, but for now it just lives here.

@Chickensoupwithrice Chickensoupwithrice marked this pull request as draft July 26, 2023 19:30
@Chickensoupwithrice
Copy link
Contributor Author

Chickensoupwithrice commented Jul 26, 2023 •
edited
Loading

There's lots of work to do around this:

  • Make sure it works
  • Docs
  • Tests
  • Implement all the API calls
  • Linting
  • Formatting

tw4l
tw4l requested changes Jul 26, 2023
View reviewed changes
Copy link
Member

@tw4l tw4l left a comment

Choose a reason for hiding this comment

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

This is a nice start! I left some comments and suggested changes :)

index.js Outdated Show resolved Hide resolved
index.js Outdated Show resolved Hide resolved
index.js Outdated Show resolved Hide resolved
index.js Outdated Show resolved Hide resolved
index.js Outdated Show resolved Hide resolved
index.js Outdated Show resolved Hide resolved
index.js Outdated Show resolved Hide resolved
@Chickensoupwithrice Chickensoupwithrice changed the title feat: init; stolen from ilya feat: Init Jul 26, 2023
@Chickensoupwithrice
Copy link
Contributor Author

Chickensoupwithrice commented Jul 28, 2023 •
edited
Loading

List of all the endpoints and their status. I'm not planning on implementing all of these in a first pass, but at least we'll have a record of what's implemented and what's left.

  • Auth
    • Login
    • Logout
    • Refresh
    • Register
    • Forgot Password
    • Rest Password
    • Request Verify Token
    • Verify
  • Users
    • Get Me
    • Patch Me
    • Get User ID
    • Delete User ID
    • Patch User ID
    • Me with Orgs
    • Get Invite Info
    • Get Existing User Invite Info
    • Get Pending Invites
  • invites
    • Get Invite Info
    • Get existing invite info
    • Get pending invites
    • Accept Invite
    • Invite user to org
    • Get Pending org invites
    • Delete Invite
    • Remove user from org
    • Add user to org
  • Organizations
    • Get Orgs
    • Create Orgs
    • Get Org
    • Rename Org
    • Update Quotas
    • Set Role
    • Update Storage
  • All Crawls
    • List all base crawls
    • Get base crawls
    • Get Base crawl admin
    • Get Crawl
    • Delete Crawl all types
  • Crawls
    • List crawls admin
    • List Crawls
    • Crawl Cancel Immediately
    • Crawl graceful stop
    • Delete Crawls
    • Get Crawl Admin
    • Get Crawl
    • List single admin crawl
    • List single crawl
    • Update crawl API
    • Scale Crawl
    • Access Check
    • Get Crawl Queue
    • Match Crawl Queue
    • Add exclusion
    • Remove exclusion
    • Stream crawl logs
    • Get Crawl Errors
  • Uploads
    • Upload Form Data
    • Upload Stream
    • List Uploads
    • Get Upload
    • Get upload replay action
    • Get upload replay
    • Update Uploads API
    • Delete uploads
  • Collections
    • List Collection All
    • Add collection
    • Get Collection All
    • Get Collection search values
    • Get Collection
    • Delete Collection
    • Update Collection
    • Get Collection Replay
    • Add crawl to collection
    • Remove crawl from collection
    • Download Collection
  • Profiles
    • List profiles
    • Commit browser to new
    • Get Profile
    • Delete Profile
    • Commit browser to existing
    • Create new
    • Ping profile browser
    • Navigate profile browser
    • Get Profile Browser URL
    • Delete Profile Browser
    • Access Check
  • Crawl Configs
    • Get Crawl Configs
    • Get Crawl Config Tags
    • Get Crawl Config Search Values
    • Get Crawl Config Out
    • Make Inactive
    • Update crawl config
    • Get Crawl Config Revisions
    • Add Crawl Config
    • Run Now
  • Get Settings

@Chickensoupwithrice Chickensoupwithrice marked this pull request as ready for review August 1, 2023 02:04
Chickensoupwithrice
Chickensoupwithrice commented Aug 1, 2023
View reviewed changes
package.json
"url": "git+https://github.com/webrecorder/browsertrix-client.git"
},
"author": "Webrecorder",
"license": "AGPL-3.0-or-later",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I took this from browsertrix-cloud, I presume it's okay here too? (It may even be required?)

Copy link
Member

Choose a reason for hiding this comment

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

Seems reasonable for the client to have the same license as the application!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tw4l tw4l tw4l approved these changes

@ikreymer ikreymer Awaiting requested review from ikreymer

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Chickensoupwithrice @tw4l