// eslint-disable-next-line
30 | /**
31 | * Initialize a new `History`.
32 | * @api public
33 | */
34 |
35 | export function newHistory() {
36 | const pages = []
37 | let theCurrentPage = null
38 |
39 | const push = (page) => {
40 | pages.push(page)
41 | theCurrentPage = page
42 | }
43 |
44 | const currentPage = () => theCurrentPage
45 |
46 | return Object.freeze({
47 | currentPage,
48 | push,
49 | })
50 | }
51 |
9 |
27 |
28 |
29 |
30 |
--------------------------------------------------------------------------------
/lib/mechanize/page/link.js:
--------------------------------------------------------------------------------
1 | import { nodeAttr, search, textContent } from '../utils.js'
2 |
3 | // eslint-disable object-curly-newline
4 | export function newLink(node, page) {
5 | const agent = page.agent
6 | const link = {}
7 | const href = nodeAttr(node, 'href')
8 | const relVal = nodeAttr(node, 'rel')
9 | const rel = relVal ? relVal.toLowerCase().split(' ') : []
10 | const uri = page.resolveUrl(href)
11 |
12 | const relIncludes = (kind) => rel.includes(kind)
13 |
14 | const click = () => agent.click(link)
15 |
16 | const text = () =>
17 | textContent(node) ||
18 | search(node, '//img')
19 | .map((node) => nodeAttr(node, 'alt'))
20 | .join('')
21 |
22 | const getPage = (options) =>
23 | agent.get(
24 | Object.assign(
25 | {
26 | uri,
27 | },
28 | options
29 | )
30 | )
31 |
32 | Object.assign(link, {
33 | attributes: node,
34 | click,
35 | domClass: nodeAttr(node, 'class'),
36 | domId: nodeAttr(node, 'id'),
37 | getPage,
38 | href,
39 | node,
40 | page,
41 | referrer: page,
42 | rel,
43 | relIncludes,
44 | search: (xpath) => (node && search(node, xpath)) || [],
45 | text,
46 | toString: text,
47 | uri,
48 | })
49 |
50 | return Object.freeze(link)
51 | }
52 |
--------------------------------------------------------------------------------
/lib/mechanize/form/checkbox.js:
--------------------------------------------------------------------------------
1 | // eslint-disable-next-line
2 | /**
3 | * Initialize a new `Checkbox` field with the given `node` of the
4 | * given `form`.
5 | * If `initialValue` is undefined, uses the "value" attribute of `node`.
6 | *
7 | * @param {Element} node
8 | * @param {Form} form the form that includes this button
9 | * @param {String} initialValue
10 | * @api public
11 | */
12 | import { newRadioButton } from './radio_button.js'
13 |
14 | export function newCheckbox(node, form) {
15 | const radioButton = newRadioButton(node, form)
16 | const fieldType = 'checkbox'
17 | const queryValue = () => [[radioButton.name, radioButton.value() || 'on']]
18 |
19 | return Object.freeze({
20 | check: radioButton.check,
21 | click: radioButton.click,
22 | disabled: radioButton.disabled,
23 | domId: radioButton.domId,
24 | fieldType,
25 | getAttribute: radioButton.getAttribute,
26 | id: radioButton.id,
27 | isChecked: radioButton.isChecked,
28 | label: radioButton.label,
29 | name: radioButton.name,
30 | queryValue,
31 | rawValue: radioButton.rawValue,
32 | setValue: radioButton.setValue,
33 | type: radioButton.type,
34 | uncheck: radioButton.uncheck,
35 | uncheckPeers: radioButton.uncheckPeers,
36 | value: radioButton.value,
37 | })
38 | }
39 |
--------------------------------------------------------------------------------
/docs/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
19 |
20 |
51 |
52 |
55 |
56 | 57 | 58 | 61 | 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /lib/mechanize/form/file_upload.js: -------------------------------------------------------------------------------- 1 | // eslint-disable-next-line 2 | /** 3 | * Initialize a new `FileUpload` with the given `node`. 4 | * If `initialValue` is undefined, uses the "value" attribute of `node`. 5 | * 6 | * @param {Element} node 7 | * @param {String} initialValue 8 | * @api public 9 | */ 10 | import { newField } from './field.js' 11 | import * as unescape from 'unescape' 12 | 13 | export function newFileUpload(node, initialFilename) { 14 | let theFilename = unescape(initialFilename) 15 | let theMimeType 16 | const field = newField(node) 17 | const fieldType = 'fileUpload' 18 | 19 | const setFilename = (newFilename) => { 20 | theFilename = newFilename 21 | } 22 | 23 | const filename = () => theFilename 24 | 25 | const setMimeType = (newMimeType) => { 26 | theMimeType = newMimeType 27 | } 28 | 29 | const mimeType = () => theMimeType 30 | 31 | return Object.freeze({ 32 | disabled: field.disabled, 33 | domId: field.domId, 34 | fieldType, 35 | fileData: field.value, 36 | filename, 37 | getAttribute: field.getAttribute, 38 | mimeType, 39 | name: field.name, 40 | queryValue: field.queryValue, 41 | rawValue: field.rawValue, 42 | setFileData: field.setValue, 43 | setFilename, 44 | setMimeType, 45 | setValue: field.setValue, 46 | type: field.type, 47 | value: field.value, 48 | }) 49 | } 50 | -------------------------------------------------------------------------------- /lib/mechanize/page/image.js: -------------------------------------------------------------------------------- 1 | import * as path from 'path' 2 | import { nodeAttr } from '../utils.js' 3 | 4 | export function newImage({ node, page }) { 5 | const getAttribute = (name) => nodeAttr(node, name) 6 | 7 | const agent = page.agent 8 | const alt = getAttribute('alt') 9 | const caption = getAttribute('rel') 10 | const domClass = getAttribute('class') 11 | const domId = getAttribute('id') 12 | const height = getAttribute('height') 13 | const src = getAttribute('src') 14 | const isRelative = !src.match(/^https?:\/\//) 15 | const extname = src && path.extname(src) 16 | const title = getAttribute('title') 17 | // eslint-disable-next-line 18 | const url = isRelative 19 | ? page.bases[0] 20 | ? page.bases[0].href + src 21 | : page.uri + encodeURIComponent(src) 22 | : encodeURIComponent(src) 23 | const width = getAttribute('width') 24 | const imageReferrer = 1 25 | 26 | const fetch = ({ params, referrer, headers }) => 27 | agent.get({ 28 | uri: src, 29 | params, 30 | referrer: referrer || imageReferrer, 31 | headers, 32 | }) 33 | 34 | return Object.freeze({ 35 | agent, 36 | alt, 37 | caption, 38 | domClass, 39 | domId, 40 | extname, 41 | fetch, 42 | height, 43 | imageReferrer, 44 | isRelative, 45 | node, 46 | page, 47 | src, 48 | text: caption, 49 | title, 50 | uri: url, 51 | url, 52 | width, 53 | }) 54 | } 55 | -------------------------------------------------------------------------------- /lib/mechanize/form/image_button.js: -------------------------------------------------------------------------------- 1 | // eslint-disable-next-line 2 | /** 3 | * Initialize a new `ImageButton` with the given `node`. 4 | * If `initialValue` is undefined, uses the "value" attribute of `node`. 5 | * 6 | * @param {Element} node 7 | * @param {String} initialValue 8 | * @api public 9 | */ 10 | import { newSubmit } from './submit.js' 11 | 12 | export function newImageButton(node, initialValue) { 13 | const button = newSubmit(node, initialValue) 14 | let theX, theY 15 | const fieldType = 'imageButton' 16 | 17 | const queryValue = () => 18 | button.queryValue().concat([ 19 | [button.name + '.x', (theX || 0).toString()], 20 | [button.name + '.y', (theY || 0).toString()], 21 | ]) 22 | 23 | const setX = (newX) => { 24 | theX = newX 25 | } 26 | 27 | const x = () => theX 28 | 29 | const setY = (newY) => { 30 | theY = newY 31 | } 32 | 33 | const y = () => theY 34 | 35 | return Object.freeze({ 36 | disabled: button.disabled, 37 | domId: button.domId, 38 | fieldType, 39 | formAction: button.formAction, 40 | formEcntype: button.formEcntype, 41 | formMethod: button.formMethod, 42 | formNoValidate: button.formNoValidate, 43 | formTarget: button.formTarget, 44 | getAttribute: button.getAttribute, 45 | name: button.name, 46 | queryValue, 47 | rawValue: button.rawValue, 48 | setValue: button.setValue, 49 | setX, 50 | setY, 51 | type: button.type, 52 | value: button.value, 53 | x, 54 | y, 55 | }) 56 | } 57 | -------------------------------------------------------------------------------- /.github/workflows/test-actions.yml: -------------------------------------------------------------------------------- 1 | name: build-actions 2 | on: [push] 3 | jobs: 4 | run: 5 | runs-on: ${{ matrix.os }} 6 | strategy: 7 | matrix: 8 | os: [ubuntu-latest, macos-latest, windows-latest] 9 | node-version: [18.x, 20.x, 22.x] 10 | env: 11 | OS: ${{ matrix.os }} 12 | steps: 13 | - name: Set git to use LF 14 | run: | 15 | git config --global core.autocrlf false 16 | git config --global core.eol lf 17 | - name: Checkout 18 | uses: actions/checkout@master 19 | with: 20 | fetch-depth: 1 # ! We only skip if the tippy top commit says so! 21 | persist-credentials: false 22 | - name: Reconfigure git to use HTTP authentication 23 | run: > 24 | git config --global url."https://github.com/".insteadOf 25 | ssh://git@github.com/ 26 | - uses: actions/setup-node@v4.0.2 27 | with: 28 | node-version: ${{ matrix.node-version }} 29 | - run: npm install 30 | - run: npm run lint 31 | - run: npm run lint-markdown 32 | - run: npm test 33 | - run: npm run coverage 34 | - name: Upload coverage to Codecov 35 | uses: codecov/codecov-action@v4.3.0 36 | with: 37 | token: ${{ secrets.CODECOV_TOKEN }} 38 | file: clover.xml 39 | flags: unittests 40 | name: codecov-mechanize 41 | fail_ci_if_error: true 42 | verbose: true 43 | directory: ./coverage/ 44 | env_vars: OS 45 | -------------------------------------------------------------------------------- /lib/mechanize/utils.js: -------------------------------------------------------------------------------- 1 | import { JSDOM } from 'jsdom' 2 | 3 | const XPathResult = {} 4 | XPathResult.ANY_TYPE = 0 5 | XPathResult.ORDERED_NODE_ITERATOR_TYPE = 0 6 | XPathResult.FIRST_ORDERED_NODE_TYPE = 9 7 | 8 | const parseHtmlString = (body) => { 9 | let doc 10 | try { 11 | const dom = new JSDOM(body) 12 | doc = dom.window.document 13 | } catch (error) { 14 | console.warn(error) // eslint-disable-line no-console 15 | } 16 | return doc 17 | } 18 | 19 | const xPathResultToArray = (xPathResult) => { 20 | const array = [] 21 | let node = xPathResult.iterateNext() 22 | 23 | while (node) { 24 | array.push(node) 25 | node = xPathResult.iterateNext() 26 | } 27 | return array 28 | } 29 | 30 | const nodeAttr = (node, name) => { 31 | if (node) { 32 | if (node.getAttribute) { 33 | return node.getAttribute(name) 34 | } 35 | return node[name] 36 | } 37 | return undefined 38 | } 39 | 40 | const evaluate = (xpathExpression, contextNode, resultType) => { 41 | const document = 42 | contextNode.constructor.name === 'Document' 43 | ? contextNode 44 | : contextNode.ownerDocument 45 | return document.evaluate(xpathExpression, contextNode, null, resultType, null) 46 | } 47 | 48 | const at = (doc, xpathExpression) => 49 | evaluate(xpathExpression, doc, XPathResult.FIRST_ORDERED_NODE_TYPE) 50 | .singleNodeValue 51 | 52 | const search = (doc, xpathExpression) => 53 | xPathResultToArray( 54 | evaluate(xpathExpression, doc, XPathResult.ORDERED_NODE_ITERATOR_TYPE) 55 | ) 56 | 57 | const textContent = (element) => element && element.textContent 58 | 59 | export { at, nodeAttr, parseHtmlString, search, textContent } 60 | -------------------------------------------------------------------------------- /spec/fixtures/links.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 |
9 | Contact Us
10 | Privacy
11 | Site Map
12 | Help
13 |
30 | Where do I enter my password?
31 | Need to activate Online Banking?
32 |
14 |
29 | -
15 |
- 16 | Terms & Conditions 17 | 18 |
- 19 | Important Security Alert 20 | 21 |
- 22 | Other Online Services 23 | 24 |
- 25 | Example.com 26 | 27 |
33 | Need assistance? Call us at 1-800-555-1212 or try our Online Help. 34 |
35 | 36 | 37 | -------------------------------------------------------------------------------- /docs/history.js.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 |
19 |
20 |
28 |
29 |
53 |
54 |
55 |
56 |
57 |
58 |
59 |
60 |
63 |
64 | Source: history.js
21 | 22 | 23 | 24 | 25 | 26 | 27 |65 | 66 | 69 | 70 | 71 | 72 | 73 | 74 | -------------------------------------------------------------------------------- /lib/mechanize/form/radio_button.js: -------------------------------------------------------------------------------- 1 | // eslint-disable-next-line 2 | /** 3 | * Initialize a new `RadioButton` field with the given `node` of the 4 | * given `form`. 5 | * If `initialValue` is undefined, uses the "value" attribute of `node`. 6 | * 7 | * @param {Form} form the form that includes this button 8 | * @param {Element} node 9 | * @param {String} initialValue 10 | * @api public 11 | */ 12 | import { newField } from './field.js' 13 | 14 | export function newRadioButton(node, form) { 15 | const field = newField(node) 16 | let checked = Boolean(field.getAttribute('checked')) 17 | const fieldType = 'radioButton' 18 | const uncheckPeers = () => 19 | form.radiobuttons().forEach((radioButton) => { 20 | if ( 21 | radioButton.name() === field.name && 22 | radioButton.value() !== field.value() 23 | ) { 24 | radioButton.uncheck() 25 | } 26 | }) 27 | 28 | const check = () => { 29 | uncheckPeers() 30 | checked = true 31 | } 32 | 33 | const isChecked = () => checked 34 | 35 | const uncheck = () => { 36 | checked = false 37 | } 38 | 39 | const click = () => { 40 | if (isChecked()) { 41 | uncheck() 42 | } else { 43 | check() 44 | } 45 | } 46 | 47 | const label = () => form.labelFor(field.domId) 48 | 49 | const text = () => label() && label().text 50 | 51 | return Object.freeze({ 52 | check, 53 | click, 54 | disabled: field.disabled, 55 | domId: field.domId, 56 | fieldType, 57 | form, 58 | getAttribute: field.getAttribute, 59 | isChecked, 60 | label, 61 | name: field.name, 62 | queryValue: field.queryValue, 63 | rawValue: field.rawValue, 64 | setValue: field.setValue, 65 | text, 66 | type: field.type, 67 | uncheck, 68 | uncheckPeers, 69 | value: field.value, 70 | }) 71 | } 72 | -------------------------------------------------------------------------------- /lib/mechanize/form/submit.js: -------------------------------------------------------------------------------- 1 | // eslint-disable-next-line 2 | /** 3 | * Initialize a new `Submit` button with the given `node`. 4 | * If `initialValue` is undefined, uses the "value" attribute of `node`. 5 | * 6 | * @param {Element} node 7 | * @param {String} initialValue 8 | * @api public 9 | */ 10 | import { newButton } from './button.js' 11 | 12 | export function newSubmit(node, initialValue) { 13 | const button = newButton(node, initialValue) 14 | const fieldType = 'submit' 15 | const formAction = button.getAttribute('formaction') 16 | const formTarget = button.getAttribute('formtarget') 17 | 18 | const getEnctype = (button) => { 19 | const attribute = button.getAttribute('formecntype') 20 | if (!attribute) { 21 | return undefined 22 | } else if ( 23 | attribute === 'multipart/form-data' || 24 | attribute === 'text/plain' 25 | ) { 26 | return attribute 27 | } 28 | return 'application/x-www-form-urlencoded' 29 | } 30 | 31 | const getMethod = (button) => { 32 | const attribute = button.getAttribute('formmethod') 33 | if (!attribute) { 34 | return undefined 35 | } else if (attribute.match(/^post$/i)) { 36 | return 'POST' 37 | } 38 | return 'GET' 39 | } 40 | 41 | const getBoolean = (button, name) => Boolean(button.getAttribute(name)) 42 | 43 | const formEcntype = getEnctype(button) 44 | const formMethod = getMethod(button) 45 | const formNoValidate = getBoolean(button, 'formnovalidate') 46 | 47 | return Object.freeze({ 48 | disabled: button.disabled, 49 | domId: button.domId, 50 | fieldType, 51 | formAction, 52 | formEcntype, 53 | formMethod, 54 | formNoValidate, 55 | formTarget, 56 | getAttribute: button.getAttribute, 57 | name: button.name, 58 | queryValue: button.queryValue, 59 | rawValue: button.rawValue, 60 | setValue: button.setValue, 61 | type: button.type, 62 | value: button.value, 63 | }) 64 | } 65 | -------------------------------------------------------------------------------- /lib/mechanize/form/keygen.js: -------------------------------------------------------------------------------- 1 | // eslint-disable-next-line 2 | /** 3 | * Initialize a new `Keygen` with the given `node`. 4 | * If `initialValue` is undefined, uses the "value" attribute of `node`. 5 | * 6 | * @param {Element} node 7 | * @param {String} initialValue 8 | * @api public 9 | */ 10 | import { newField } from './field' 11 | 12 | export function newKeygen(node, initialValue) { 13 | const field = newField(node, initialValue) 14 | let generatedKey 15 | const fieldType = 'keygen' 16 | const challenge = field.getAttribute('challenge') 17 | const key = () => generatedKey 18 | const generateKey = (keySize = 2049) => { 19 | // eslint-disable-next-line 20 | // TODO: implement 21 | // spec at http://dev.w3.org/html5/spec/Overview.html#the-keygen-element 22 | // @spki = OpenSSL::Netscape::SPKI.new 23 | // @spki.challenge = @challenge 24 | // generatedKey = OpenSSL::PKey::RSA.new(keySize); 25 | // @spki.public_key = generatedKey.public_key 26 | // @spki.sign(generatedKey, OpenSSL::Digest::MD5.new); 27 | // self.value = @spki.to_pem 28 | 29 | // note: I could not figure out how to do this with the Node.JS crypto lib 30 | // const spki = { 31 | // spkac: { 32 | // pubkey: {}, 33 | // challenge: '' 34 | // }, 35 | // sig_algor: {}, 36 | // signature: '' 37 | // }; 38 | // spki.spkac.challenge = challenge; 39 | // const RSA_F4 = 0x10001; // 65537 40 | // generatedKey = new RSA(keySize, RSA_F4); 41 | // spki.public_key = generatedKey; 42 | // generatedKey = ''; 43 | const pem = String(keySize) 44 | field.setValue(pem) 45 | } 46 | 47 | if (!initialValue) { 48 | generateKey() 49 | } 50 | 51 | return Object.freeze({ 52 | challenge, 53 | disabled: field.disabled, 54 | domId: field.domId, 55 | fieldType, 56 | generateKey, 57 | getAttribute: field.getAttribute, 58 | key, 59 | name: field.name, 60 | queryValue: field.queryValue, 61 | rawValue: field.rawValue, 62 | setValue: field.setValue, 63 | type: field.type, 64 | value: field.value, 65 | }) 66 | } 67 | -------------------------------------------------------------------------------- /lib/mechanize/page/link.test.js: -------------------------------------------------------------------------------- 1 | import { newLink } from './link' 2 | import { newPage } from '../page' 3 | import { beforeEach, describe, expect, it } from 'vitest' 4 | 5 | describe('Mechanize/Page/Link', () => { 6 | let link, href, nodeID, page, node 7 | 8 | beforeEach(() => { 9 | const agent = {} 10 | const body = 11 | '' + 12 | 'Example' + 13 | '' + 14 | '
' +
15 | ''
16 | page = newPage({
17 | body,
18 | agent,
19 | })
20 | })
21 |
22 | describe('text link', () => {
23 | beforeEach(() => {
24 | node = page.at('//a[1]')
25 | href = 'http://example.com/first'
26 | nodeID = 'first'
27 | link = newLink(node, page)
28 | })
29 |
30 | it('should exist', () => {
31 | expect(link).toEqual(
32 | expect.objectContaining({
33 | text: expect.any(Function),
34 | })
35 | )
36 | })
37 |
38 | it('should have href', () => {
39 | expect(link.href).toEqual(href)
40 | })
41 |
42 | it('should have domId', () => {
43 | expect(link.domId).toEqual(nodeID)
44 | })
45 |
46 | it('should have text', () => {
47 | expect(link.text()).toEqual('Example')
48 | })
49 | })
50 |
51 | describe('image link', () => {
52 | beforeEach(() => {
53 | node = page.at('//a[2]')
54 | href = 'http://example.com/second'
55 | nodeID = 'second'
56 | link = newLink(node, page)
57 | })
58 |
59 | it('should exist', () => {
60 | expect(link).toEqual(
61 | expect.objectContaining({
62 | text: expect.any(Function),
63 | })
64 | )
65 | })
66 |
67 | it('should have href', () => {
68 | expect(link.href).toEqual(href)
69 | })
70 |
71 | it('should have domId', () => {
72 | expect(link.domId).toEqual(nodeID)
73 | })
74 |
75 | it('should have text', () => {
76 | expect(link.text()).toEqual('picture')
77 | })
78 | })
79 | })
80 |
--------------------------------------------------------------------------------
/docs/styles/prettify-jsdoc.css:
--------------------------------------------------------------------------------
1 | /* JSDoc prettify.js theme */
2 |
3 | /* plain text */
4 | .pln {
5 | color: #000000;
6 | font-weight: normal;
7 | font-style: normal;
8 | }
9 |
10 | /* string content */
11 | .str {
12 | color: #006400;
13 | font-weight: normal;
14 | font-style: normal;
15 | }
16 |
17 | /* a keyword */
18 | .kwd {
19 | color: #000000;
20 | font-weight: bold;
21 | font-style: normal;
22 | }
23 |
24 | /* a comment */
25 | .com {
26 | font-weight: normal;
27 | font-style: italic;
28 | }
29 |
30 | /* a type name */
31 | .typ {
32 | color: #000000;
33 | font-weight: normal;
34 | font-style: normal;
35 | }
36 |
37 | /* a literal value */
38 | .lit {
39 | color: #006400;
40 | font-weight: normal;
41 | font-style: normal;
42 | }
43 |
44 | /* punctuation */
45 | .pun {
46 | color: #000000;
47 | font-weight: bold;
48 | font-style: normal;
49 | }
50 |
51 | /* lisp open bracket */
52 | .opn {
53 | color: #000000;
54 | font-weight: bold;
55 | font-style: normal;
56 | }
57 |
58 | /* lisp close bracket */
59 | .clo {
60 | color: #000000;
61 | font-weight: bold;
62 | font-style: normal;
63 | }
64 |
65 | /* a markup tag name */
66 | .tag {
67 | color: #006400;
68 | font-weight: normal;
69 | font-style: normal;
70 | }
71 |
72 | /* a markup attribute name */
73 | .atn {
74 | color: #006400;
75 | font-weight: normal;
76 | font-style: normal;
77 | }
78 |
79 | /* a markup attribute value */
80 | .atv {
81 | color: #006400;
82 | font-weight: normal;
83 | font-style: normal;
84 | }
85 |
86 | /* a declaration */
87 | .dec {
88 | color: #000000;
89 | font-weight: bold;
90 | font-style: normal;
91 | }
92 |
93 | /* a variable name */
94 | .var {
95 | color: #000000;
96 | font-weight: normal;
97 | font-style: normal;
98 | }
99 |
100 | /* a function name */
101 | .fun {
102 | color: #000000;
103 | font-weight: bold;
104 | font-style: normal;
105 | }
106 |
107 | /* Specify class=linenums on a pre to get line numbering */
108 | ol.linenums {
109 | margin-top: 0;
110 | margin-bottom: 0;
111 | }
112 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "mechanize",
3 | "version": "1.5.0",
4 | "description": "Automate interaction with websites (web scraping)",
5 | "keywords": [
6 | "dom",
7 | "scraper",
8 | "javascript"
9 | ],
10 | "homepage": "https://github.com/srveit/mechanize-js/wiki",
11 | "repository": {
12 | "type": "git",
13 | "url": "git@github.com:srveit/mechanize-js.git"
14 | },
15 | "bugs": {
16 | "email": "steve@veitconsulting.com",
17 | "url": "https://github.com/srveit/mechanize-js/issues"
18 | },
19 | "license": "MIT",
20 | "author": {
21 | "name": "Stephen R. Veit",
22 | "email": "steve@veitconsulting.com",
23 | "url": "http://veitconsulting.com"
24 | },
25 | "contributors": [
26 | {
27 | "name": "佐藤"
28 | },
29 | {
30 | "name": "Dan Rahmel"
31 | },
32 | {
33 | "name": "Anders Hjelm"
34 | }
35 | ],
36 | "main": "./lib/mechanize.js",
37 | "bin": {},
38 | "man": [],
39 | "directories": {
40 | "lib": "./lib/mechanize"
41 | },
42 | "config": {},
43 | "scripts": {
44 | "coverage": "vitest run --coverage",
45 | "docs": "jsdoc --configure .jsdocrc.json",
46 | "format": "prettier --write .",
47 | "lint": "prettier --check . && eslint .",
48 | "lint-markdown": "markdownlint-cli2 \"**/*.md\" \"#node_modules\"",
49 | "test": "vitest"
50 | },
51 | "watch": {
52 | "lint": {
53 | "patterns": [
54 | "{lib,spec}/*.js"
55 | ],
56 | "quiet": true
57 | }
58 | },
59 | "jest": {
60 | "testEnvironment": "node",
61 | "collectCoverage": true,
62 | "coverageProvider": "v8",
63 | "coverageDirectory": "./coverage/",
64 | "coverageReporters": [
65 | "clover",
66 | "json",
67 | "html",
68 | "text-summary"
69 | ],
70 | "coverageThreshold": {
71 | "global": {
72 | "lines": 75
73 | }
74 | }
75 | },
76 | "dependencies": {
77 | "jsdom": "^24.1.0",
78 | "mime": "^4.0.3",
79 | "node-fetch": "^3.3.2",
80 | "tough-cookie": "^4.1.4",
81 | "unescape": "^1.0.1",
82 | "windows-1252": "^3.0.4"
83 | },
84 | "type": "module",
85 | "overrides": {},
86 | "engines": {
87 | "node": ">= 18.0.0"
88 | },
89 | "devDependencies": {
90 | "@stylistic/eslint-plugin": "^2.1.0",
91 | "@vitest/coverage-v8": "^1.6.0",
92 | "ajv": "^8.16.0",
93 | "ajv-keywords": "^5.1.0",
94 | "eslint": "^8.57.0",
95 | "eslint-plugin-jsonc": "^2.16.0",
96 | "express": "^4.19.2",
97 | "jsdoc": "^4.0.3",
98 | "markdownlint-cli2": "^0.13.0",
99 | "prettier": "^3.3.1",
100 | "vitest": "^1.6.0"
101 | }
102 | }
103 |
--------------------------------------------------------------------------------
/docs/styles/prettify-tomorrow.css:
--------------------------------------------------------------------------------
1 | /* Tomorrow Theme */
2 | /* Original theme - https://github.com/chriskempson/tomorrow-theme */
3 | /* Pretty printing styles. Used with prettify.js. */
4 | /* SPAN elements with the classes below are added by prettyprint. */
5 | /* plain text */
6 | .pln {
7 | color: #4d4d4c; }
8 |
9 | @media screen {
10 | /* string content */
11 | .str {
12 | color: #718c00; }
13 |
14 | /* a keyword */
15 | .kwd {
16 | color: #8959a8; }
17 |
18 | /* a comment */
19 | .com {
20 | color: #8e908c; }
21 |
22 | /* a type name */
23 | .typ {
24 | color: #4271ae; }
25 |
26 | /* a literal value */
27 | .lit {
28 | color: #f5871f; }
29 |
30 | /* punctuation */
31 | .pun {
32 | color: #4d4d4c; }
33 |
34 | /* lisp open bracket */
35 | .opn {
36 | color: #4d4d4c; }
37 |
38 | /* lisp close bracket */
39 | .clo {
40 | color: #4d4d4c; }
41 |
42 | /* a markup tag name */
43 | .tag {
44 | color: #c82829; }
45 |
46 | /* a markup attribute name */
47 | .atn {
48 | color: #f5871f; }
49 |
50 | /* a markup attribute value */
51 | .atv {
52 | color: #3e999f; }
53 |
54 | /* a declaration */
55 | .dec {
56 | color: #f5871f; }
57 |
58 | /* a variable name */
59 | .var {
60 | color: #c82829; }
61 |
62 | /* a function name */
63 | .fun {
64 | color: #4271ae; } }
65 | /* Use higher contrast and text-weight for printable form. */
66 | @media print, projection {
67 | .str {
68 | color: #060; }
69 |
70 | .kwd {
71 | color: #006;
72 | font-weight: bold; }
73 |
74 | .com {
75 | color: #600;
76 | font-style: italic; }
77 |
78 | .typ {
79 | color: #404;
80 | font-weight: bold; }
81 |
82 | .lit {
83 | color: #044; }
84 |
85 | .pun, .opn, .clo {
86 | color: #440; }
87 |
88 | .tag {
89 | color: #006;
90 | font-weight: bold; }
91 |
92 | .atn {
93 | color: #404; }
94 |
95 | .atv {
96 | color: #060; } }
97 | /* Style */
98 | /*
99 | pre.prettyprint {
100 | background: white;
101 | font-family: Consolas, Monaco, 'Andale Mono', monospace;
102 | font-size: 12px;
103 | line-height: 1.5;
104 | border: 1px solid #ccc;
105 | padding: 10px; }
106 | */
107 |
108 | /* Specify class=linenums on a pre to get line numbering */
109 | ol.linenums {
110 | margin-top: 0;
111 | margin-bottom: 0; }
112 |
113 | /* IE indents via margin-left */
114 | li.L0,
115 | li.L1,
116 | li.L2,
117 | li.L3,
118 | li.L4,
119 | li.L5,
120 | li.L6,
121 | li.L7,
122 | li.L8,
123 | li.L9 {
124 | /* */ }
125 |
126 | /* Alternate shading for lines */
127 | li.L1,
128 | li.L3,
129 | li.L5,
130 | li.L7,
131 | li.L9 {
132 | /* */ }
133 |
--------------------------------------------------------------------------------
/lib/mechanize/page.js:
--------------------------------------------------------------------------------
1 | import { URL } from 'url'
2 | import { newForm } from './form.js'
3 | import { newLink } from './page/link.js'
4 | import { at, nodeAttr, parseHtmlString, search, textContent } from './utils.js'
5 |
6 | export function newPage({ uri, response, body, agent }) {
7 | const page = {}
8 | const doc = parseHtmlString(body)
9 |
10 | // eslint-disable-next-line
11 | // TODO: initialize
12 | const labels = {}
13 |
14 | const form = (name) => {
15 | const forms = search(doc, '//form')
16 | const element =
17 | forms[name] ||
18 | forms.find(
19 | (node) =>
20 | nodeAttr(node, 'id') === name || nodeAttr(node, 'name') === name
21 | )
22 |
23 | return element && newForm(page, element)
24 | }
25 |
26 | // eslint-disable-next-line
27 | // TODO: implement
28 | const isHttp = 1
29 |
30 | // eslint-disable-next-line
31 | // TODO: implement
32 | const isHttps = 1
33 |
34 | const labelFor = (id) => labels[id]
35 |
36 | const links = () =>
37 | ['a', 'area'].reduce(
38 | (allLinks, tag) =>
39 | allLinks.concat(
40 | search(doc, '//' + tag).reduce(
41 | (links, node) => links.concat(newLink(node, page)),
42 | []
43 | )
44 | ),
45 | []
46 | )
47 |
48 | const resolveUrl = (url) => new URL(url, page.uri).toString()
49 |
50 | const responseHeaderCharset = () =>
51 | Object.entries(response.headers || {}).reduce((charsets, [name, value]) => {
52 | // eslint-disable-line no-unused-vars
53 | const m = value && /charset=([-().:_0-9a-zA-z]+)/.exec(value)
54 | return m ? charsets.concat(m[1]) : charsets
55 | }, [])
56 |
57 | const statusCode = () => response && response.statusCode
58 |
59 | const submit = ({ form, button, headers, requestOptions }) =>
60 | agent.submit({
61 | form,
62 | button,
63 | headers,
64 | redirect: requestOptions && requestOptions.redirect,
65 | })
66 |
67 | const title = () => {
68 | const node = at(doc, '//title')
69 | return textContent(node)
70 | }
71 |
72 | const userAgent = agent && agent.userAgent
73 |
74 | const userAgentVersion = agent && agent.userAgentVersion
75 |
76 | Object.assign(page, {
77 | agent,
78 | at: (xpathExpression) => at(doc, xpathExpression),
79 | body,
80 | doc,
81 | form,
82 | isHttp,
83 | isHttps,
84 | labelFor,
85 | links,
86 | resolveUrl,
87 | responseHeaders: response && response.headers,
88 | responseHeaderCharset,
89 | search: (xpathExpression) => search(doc, xpathExpression),
90 | statusCode,
91 | submit,
92 | title,
93 | uri,
94 | userAgent,
95 | userAgentVersion,
96 | })
97 |
98 | return Object.freeze(page)
99 | }
100 |
--------------------------------------------------------------------------------
/lib/mechanize/constants.js:
--------------------------------------------------------------------------------
1 | export const VERSION = '1.0.0'
2 | export const USER_AGENTS = {
3 | Mechanize:
4 | `Mechanize/${VERSION} Node.js/${process.version} ` +
5 | '(http://github.com/srveit/mechanize-js/)',
6 | 'Linux Firefox':
7 | 'Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:43.0) ' +
8 | 'Gecko/20100101 Firefox/43.0',
9 | 'Linux Konqueror': 'Mozilla/5.0 (compatible; Konqueror/3; Linux)',
10 | 'Linux Mozilla':
11 | 'Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.4) ' + 'Gecko/20030624',
12 | 'Mac Firefox':
13 | 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.11; rv:43.0) ' +
14 | 'Gecko/20100101 Firefox/43.0',
15 | 'Mac Mozilla':
16 | 'Mozilla/5.0 (Macintosh; U; PPC Mac OS X Mach-O; en-US; ' +
17 | 'rv:1.4a) Gecko/20030401',
18 | 'Mac Safari 4':
19 | 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_2; de-at) ' +
20 | 'AppleWebKit/531.21.8 (KHTML, like Gecko) Version/4.0.4 ' +
21 | 'Safari/531.21.10',
22 | 'Mac Safari':
23 | 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ' +
24 | 'AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.4.1 Safari/605.1.15',
25 | 'Windows Chrome':
26 | 'Mozilla/5.0 (Windows NT 6.1; WOW64) ' +
27 | 'AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.125 ' +
28 | 'Safari/537.36',
29 | 'Windows IE 6': 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)',
30 | 'Windows IE 7':
31 | 'Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; ' +
32 | '.NET CLR 1.1.4322; .NET CLR 2.0.50727)',
33 | 'Windows IE 8':
34 | 'Mozilla/5.0 (compatible; MSIE 8.0; Windows NT 5.1; ' +
35 | 'Trident/4.0; .NET CLR 1.1.4322; .NET CLR 2.0.50727)',
36 | 'Windows IE 9':
37 | 'Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; ' + 'Trident/5.0)',
38 | 'Windows IE 10':
39 | 'Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.2; ' +
40 | 'WOW64; Trident/6.0)',
41 | 'Windows IE 11':
42 | 'Mozilla/5.0 (Windows NT 6.3; WOW64; Trident/7.0; ' + 'rv:11.0) like Gecko',
43 | 'Windows Edge':
44 | 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) ' +
45 | 'AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2486.0 ' +
46 | 'Safari/537.36 Edge/13.10586',
47 | 'Windows Mozilla':
48 | 'Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; ' +
49 | 'rv:1.4b) Gecko/20030516 Mozilla Firebird/0.6',
50 | 'Windows Firefox':
51 | 'Mozilla/5.0 (Windows NT 6.3; WOW64; rv:43.0) ' +
52 | 'Gecko/20100101 Firefox/43.0',
53 | iPhone:
54 | 'Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) ' +
55 | 'AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B5110e ' +
56 | 'Safari/601.1',
57 | iPad:
58 | 'Mozilla/5.0 (iPad; CPU OS 9_1 like Mac OS X) ' +
59 | 'AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B143 ' +
60 | 'Safari/601.1',
61 | Android:
62 | 'Mozilla/5.0 (Linux; Android 5.1.1; Nexus 7 Build/LMY47V) ' +
63 | 'AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.76 Safari/537.36',
64 | }
65 |
--------------------------------------------------------------------------------
/docs/form_field.js.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
22 |
25 |
26 |
77 |
78 |
79 |
80 |
88 |
89 | Source: form/field.js
23 | 24 |'use strict'
27 | // eslint-disable-next-line
28 | /**
29 | * Initialize a new `Field` with the given `node`.
30 | * If `initialValue` is undefined, uses the "value" attribute of `node`.
31 | *
32 | * @param {Element} node
33 | * @param {String} initialValue
34 | * @api public
35 | */
36 | const decode = require('unescape')
37 | const { nodeAttr } = require('../utils.js')
38 |
39 | exports.newField = (node, initialValue) => {
40 | let unescapedValue
41 | const getAttribute = name => nodeAttr(node, name)
42 | const disabled = Boolean(getAttribute('disabled'))
43 | const domId = getAttribute('id')
44 | const fieldType = 'field'
45 | const name = decode(getAttribute('name'))
46 | const escapedValue = initialValue === undefined
47 | ? getAttribute('value')
48 | : initialValue
49 | const rawValue = escapedValue
50 | const type = getAttribute('type')
51 |
52 | const value = () => unescapedValue
53 |
54 | const queryValue = () => [[name, value() || '']]
55 |
56 | const setValue = newValue => {
57 | unescapedValue = newValue
58 | }
59 |
60 | unescapedValue = decode(escapedValue)
61 |
62 | return Object.freeze({
63 | disabled,
64 | domId,
65 | fieldType,
66 | getAttribute,
67 | name,
68 | queryValue,
69 | rawValue,
70 | setValue,
71 | type,
72 | value,
73 | })
74 | }
75 | 90 | 91 | 96 | 97 | 100 | 101 | 102 | 103 | -------------------------------------------------------------------------------- /docs/form_file_upload.js.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 |
22 |
25 |
26 |
78 |
79 |
80 |
81 |
89 |
90 | Source: form/file_upload.js
23 | 24 |'use strict'
27 | // eslint-disable-next-line
28 | /**
29 | * Initialize a new `FileUpload` with the given `node`.
30 | * If `initialValue` is undefined, uses the "value" attribute of `node`.
31 | *
32 | * @param {Element} node
33 | * @param {String} initialValue
34 | * @api public
35 | */
36 | const decode = require('unescape')
37 | const { newField } = require('./field')
38 |
39 | exports.newFileUpload = (node, initialFilename) => {
40 | let theFilename = decode(initialFilename)
41 | let theMimeType
42 | const field = newField(node)
43 | const fieldType = 'fileUpload'
44 |
45 | const setFilename = newFilename => {
46 | theFilename = newFilename
47 | }
48 |
49 | const filename = () => theFilename
50 |
51 | const setMimeType = newMimeType => {
52 | theMimeType = newMimeType
53 | }
54 |
55 | const mimeType = () => theMimeType
56 |
57 | return Object.freeze({
58 | disabled: field.disabled,
59 | domId: field.domId,
60 | fieldType,
61 | fileData: field.value,
62 | filename,
63 | getAttribute: field.getAttribute,
64 | mimeType,
65 | name: field.name,
66 | queryValue: field.queryValue,
67 | rawValue: field.rawValue,
68 | setFileData: field.setValue,
69 | setFilename,
70 | setMimeType,
71 | setValue: field.setValue,
72 | type: field.type,
73 | value: field.value,
74 | })
75 | }
76 | 91 | 92 | 97 | 98 | 101 | 102 | 103 | 104 | -------------------------------------------------------------------------------- /docs/global.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 |
19 |
20 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
196 |
197 |
198 |
199 |
200 |
201 |
202 |
203 |
204 |
207 |
208 | Global
21 | 22 | 23 | 24 | 25 | 26 | 27 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
83 |
84 |
85 |
86 |
87 |
88 |
89 |
90 |
91 |
92 |
93 |
94 |
95 |
96 |
97 |
98 |
99 | -
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
56 |
57 |
58 |
59 |
60 |
61 |
62 |
63 |
64 |
65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
77 |
Methods
100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 |newHistory()
108 | 109 | 110 | 111 | 112 | 113 | 114 |
115 |
117 |
118 |
119 |
120 |
121 |
122 |
123 |
124 |
125 |
126 |
127 |
128 |
129 |
130 | Initialize a new History.
-
131 |
132 |
133 |
134 |
135 |
136 |
137 |
138 |
139 |
140 |
141 |
142 |
143 |
144 |
145 |
146 |
147 |
148 |
149 |
150 |
151 |
152 |
153 |
154 |
155 |
156 |
157 |
- Source: 158 |
- 159 | history.js, line 7 160 |
161 |
162 |
163 |
164 |
165 |
166 |
167 |
168 |
209 | 210 | 213 | 214 | 215 | 216 | 217 | -------------------------------------------------------------------------------- /lib/mechanize/page.test.js: -------------------------------------------------------------------------------- 1 | import { newAgent } from './agent.js' 2 | import { newPage } from './page.js' 3 | import { fixture } from '../../spec/helpers/fixture.js' 4 | import { beforeEach, describe, expect, it } from 'vitest' 5 | 6 | describe('Mechanize/Page', () => { 7 | let response, body, page, agent 8 | 9 | beforeEach(() => { 10 | agent = newAgent() 11 | response = { 12 | headers: { 13 | 'content-type': 'text/html; charset=ISO-8859-1', 14 | }, 15 | } 16 | agent.setUserAgent('Mac Safari') 17 | }) 18 | 19 | describe('with no body', () => { 20 | beforeEach(() => { 21 | page = newPage({ 22 | response: { 23 | 'content-type': 'text/html', 24 | }, 25 | agent, 26 | }) 27 | }) 28 | 29 | it('should be created', () => { 30 | expect(page).toEqual( 31 | expect.objectContaining({ 32 | at: expect.any(Function), 33 | body: undefined, 34 | doc: expect.any(Object), 35 | form: expect.any(Function), 36 | labelFor: expect.any(Function), 37 | links: expect.any(Function), 38 | responseHeaderCharset: expect.any(Function), 39 | search: expect.any(Function), 40 | statusCode: expect.any(Function), 41 | submit: expect.any(Function), 42 | title: expect.any(Function), 43 | uri: undefined, 44 | userAgent: expect.any(Function), 45 | userAgentVersion: undefined, 46 | }) 47 | ) 48 | }) 49 | }) 50 | 51 | describe('with form', () => { 52 | let form 53 | beforeEach(async () => { 54 | body = await fixture('login.html') 55 | page = newPage({ 56 | response, 57 | body, 58 | agent, 59 | }) 60 | form = page.form('MAINFORM') 61 | }) 62 | 63 | it('should exist', () => { 64 | expect(page).toEqual( 65 | expect.objectContaining({ 66 | at: expect.any(Function), 67 | form: expect.any(Function), 68 | labelFor: expect.any(Function), 69 | links: expect.any(Function), 70 | responseHeaderCharset: expect.any(Function), 71 | search: expect.any(Function), 72 | statusCode: expect.any(Function), 73 | submit: expect.any(Function), 74 | title: expect.any(Function), 75 | }) 76 | ) 77 | }) 78 | 79 | it('should return form', () => { 80 | expect(form).toEqual( 81 | expect.objectContaining({ 82 | addField: expect.any(Function), 83 | buildQuery: expect.any(Function), 84 | checkbox: expect.any(Function), 85 | deleteField: expect.any(Function), 86 | field: expect.any(Function), 87 | fieldValue: expect.any(Function), 88 | labelFor: expect.any(Function), 89 | name: 'MAINFORM', 90 | page: expect.any(Object), 91 | requestData: expect.any(Function), 92 | setFieldValue: expect.any(Function), 93 | submit: expect.any(Function), 94 | submitButton: expect.any(Function), 95 | }) 96 | ) 97 | }) 98 | 99 | it('should return user agent', () => { 100 | expect(page.userAgent()).toMatch(/Mozilla/) 101 | }) 102 | 103 | it('should have a title', () => { 104 | expect(page.title()).toEqual('Welcome') 105 | }) 106 | 107 | it('should have responseHeaderCharset', () => { 108 | expect(page.responseHeaderCharset()).toEqual(['ISO-8859-1']) 109 | }) 110 | }) 111 | 112 | describe('with links', () => { 113 | beforeEach(async () => { 114 | body = await fixture('links.html') 115 | page = newPage({ 116 | uri: 'http://www.example.com/', 117 | response, 118 | body, 119 | agent, 120 | }) 121 | }) 122 | 123 | it('should return links', () => { 124 | expect(page.links().length).toEqual(11) 125 | }) 126 | 127 | it('should href', () => { 128 | expect(page.links()[0].href).toBe( 129 | 'http://www.example.com/about/contact/contact.asp' 130 | ) 131 | }) 132 | 133 | it('should have search', () => { 134 | expect(page.search('//a').length).toEqual(11) 135 | }) 136 | }) 137 | 138 | describe('with null parsed body', () => { 139 | let uri, response 140 | beforeEach(async () => { 141 | uri = 'https://login.yahoo.com/config/login?' 142 | response = { 143 | headers: { 144 | location: 145 | 'https://login.yahoo.com/config/verify?.done=' + 146 | 'http%3a//us.mg206.mail.yahoo.com/dc/launch%3f.partner=' + 147 | 'sbc%26.gx=0%26.rand=e7cfrljanjnfa', 148 | 'content-type': 'text/html', 149 | }, 150 | statusCode: 302, 151 | body, 152 | } 153 | 154 | body = await fixture('xml-comment.html') 155 | page = newPage({ 156 | uri, 157 | response, 158 | body, 159 | agent, 160 | }) 161 | }) 162 | 163 | it('should not have search', () => { 164 | expect(page.search('//a').length).toEqual(0) 165 | }) 166 | 167 | it('should have statusCode', () => { 168 | expect(page.statusCode()).toEqual(302) 169 | }) 170 | }) 171 | }) 172 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # mechanize 2 | 3 | [![NPM Version][npm-badge]][npm-url] 4 | [![NPM Downloads][downloads-badge]][downloads-url] 5 | [![MIT License][license-badge]][license-url] 6 | [![Node.js Version][node-version-badge]][node-version-url] 7 | [![GitHub Build Status][github-build-badge]][github-build-url] 8 | [![Codecov Status][codecov-badge]][codecov-url] 9 | [![Code Climate][code-climate-badge]][code-climate-url] 10 | [![Gitter][gitter-badge]][gitter-url] 11 | [![Known Vulnerabilities][snyk-badge]][snyk-url] 12 | 13 | 14 | 15 | The Mechanize module is used for automating interaction with websites. 16 | Mechanize automatically stores and sends cookies, follows redirects, 17 | can follow links, and submit forms. Form fields can be populated and 18 | submitted. Mechanize also keeps track of the sites that you have 19 | visited as a history. 20 | 21 | ## Getting Started 22 | 23 | From the root folder, you can run the _get_page_ example: 24 | 25 | `node examples/get_page.js` 26 | 27 | To load from a specific URL: 28 | 29 | `node examples/get_page.js "http://www.cnn.com"` 30 | 31 | The example gets the page and then performs a `console.log()` on all 32 | of the returned object data. 33 | 34 | ### Posting a form 35 | 36 | For form posting, you can run the _submit_form_ example: 37 | 38 | `node examples/submit_form.js "http://localhost/"` 39 | 40 | The example POSTs a username and password to the _/login_ path at the 41 | specificied URL. 42 | 43 | ### Chaining page accesses 44 | 45 | For an example of chaining requests, you can run the _submit_form_chain_ example: 46 | 47 | `node examples/submit_form_chain.js` 48 | 49 | ## Installation 50 | 51 | From the mechanize directory, run npm install: 52 | 53 | `npm install` 54 | 55 | ## Dependencies 56 | 57 | jsdom >= 19.0.0 58 | mime >= 3.0.0 59 | node-fetch >= 2.6.7 60 | tough-cookie >= 4.0.0 61 | unescape >= 1.0.1 62 | windows-1252 >= 1.1.0 63 | 64 | ## Documentation 65 | 66 | [mechanize-js](https://github.com/srveit/mechanize-js) 67 | 68 | ## Credits 69 | 70 | This borrows heavily from Aaron Patterson's 71 | [mechanize](https://rubygems.org/gems/mechanize) Ruby gem. 72 | 73 | ### Contributors 74 | 75 | - 佐藤 76 | - Dan Rahmel 77 | - Anders Hjelm 78 | 79 | [npm-badge]: https://img.shields.io/npm/v/mechanize.svg 80 | [npm-url]: https://npmjs.org/package/mechanize 81 | [downloads-badge]: https://img.shields.io/npm/dm/mechanize.svg 82 | [downloads-url]: https://npmjs.org/package/mechanize 83 | [node-version-badge]: https://img.shields.io/node/v/mechanize.svg 84 | [node-version-url]: https://nodejs.org/en/download/ 85 | [github-build-badge]: https://img.shields.io/github/workflow/status/srveit/mechanize-js/build-actions 86 | [github-build-url]: https://github.com/srveit/mechanize-js/actions/workflows/test-actions.yml 87 | [code-climate-badge]: https://img.shields.io/codeclimate/maintainability/srveit/mechanize-js.svg 88 | [code-climate-url]: https://codeclimate.com/github/srveit/mechanize-js 89 | [gitter-badge]: https://img.shields.io/gitter/room/mechanize-js/Lobby.svg 90 | [gitter-url]: https://gitter.im/mechanize-js/Lobby 91 | [codecov-badge]: https://img.shields.io/codecov/c/github/srveit/mechanize-js/master.svg?style=flat 92 | [codecov-url]: https://codecov.io/github/srveit/mechanize-js 93 | [license-badge]: http://img.shields.io/badge/license-MIT-blue.svg?style=flat 94 | [license-url]: http://choosealicense.com/licenses/mit/ 95 | [snyk-badge]: https://snyk.io/test/github/srveit/mechanize-js/badge.svg 96 | [snyk-url]: https://snyk.io/test/github/srveit/mechanize-js 97 | 98 | 132 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | All notable changes to this project will be documented in this file. 4 | 5 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), 6 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). 7 | 8 | ## [1.5.0] - 2024-06-07 9 | 10 | ### Changed 11 | 12 | - changed options to agent.get 13 | - use previous retrieved URL as base for partial URLs in fetchPage 14 | - updated "Mac Safari" agent string 15 | - removed field.rawValue property 16 | - change fiel.value from property to function 17 | - updated to use Node.JS v22 18 | 19 | ### Added 20 | 21 | - handle binary mime types 22 | - handle redirects in fetchPage 23 | - debug option to fetchPage and submit 24 | - agent.getCookies function 25 | 26 | ## [1.4.1] - 2024-04-25 27 | 28 | ### Changed 29 | 30 | - changed package main to lib/mechanize.js 31 | 32 | ## [1.4.0] - 2024-04-25 33 | 34 | ### Changed 35 | 36 | - agent.js: set connection header to keep-alive explicitly 37 | - Updated JavaScipt files to use ES6 modules 38 | - Use vitest instead of jest 39 | - Updated Npm module jsdom to 24.0.0 40 | - Updated Npm module mime to 4.0.2 41 | - Updated Npm module node-fetch to 3.3.2 42 | - Updated Npm module tough-cookie to 4.1.3 43 | - Updated Npm module windows-1252 to 3.0.4 44 | - Development: updated eslint and prettier 45 | - Development: updated versions of GitHub actions 46 | 47 | ## [1.3.0] - 2022-03-11 48 | 49 | ### Changed 50 | 51 | - Changed agent.get to return a JavaScript object when response is JSON 52 | - Changed fixture to return a promise 53 | - Updated Npm module eslint-config-prettier to 8.4.0 54 | - Updated spec/helpers/fixture.js to use fs/promises 55 | - Updated lib/mechanize/agent.js to use fs/promises 56 | - Updated .github/workflows/test-actions.yml to run on Node 14, 16, and 17 57 | - Updated Npm module eslint to 8.9.0 58 | - Updated Npm module eslint-plugin-promise to 6.0.0 59 | - Updated spec/form.test.js to not fix fixture EOLs since added .gitattributes 60 | - Updated lint script to run lint-markdown 61 | 62 | ### Added 63 | 64 | - File .gitattributes 65 | - File .markdownlint.json 66 | - Npm module jest-extended 67 | - Npm module jest-spec-reporter 68 | - Npm module markdownlint-cli2 69 | - Npm module standard 70 | 71 | ### Removed 72 | 73 | - Npm module jest-spec-reporter 74 | - Npm module codecov 75 | - Npm module eslint-config-standard 76 | - File appveyor.yml 77 | - File .travis.yml 78 | 79 | ## [1.2.1] - 2022-02-21 80 | 81 | ### Changed 82 | 83 | - Fixed GitHub build badge URL in README.md 84 | - Updated documentation 85 | 86 | ## [1.2.0] - 2022-02-21 87 | 88 | ### Added 89 | 90 | - File CHANGELOG.md 91 | - File lib/mechanize/utils.js 92 | - Npm module jest 93 | 94 | ### Changed 95 | 96 | - Renamed LICENSE.txt to LICENSE 97 | - Replaced request with node-fetch 98 | - Replaced cookiejar with tough-cookie 99 | - Replaced libxmljs with jsdom 100 | - Renamed spec files 101 | 102 | ### Removed 103 | 104 | - File examples/twitter_notifications.js 105 | - File spec/support/jasmine.json 106 | - Npm module jasmine 107 | - Npm module jsonlint 108 | - Npm module lodash 109 | - Npm module mime-types 110 | - Npm module moment 111 | - Npm module npm-run 112 | - Npm module nyc 113 | - Npm module nyc 114 | 115 | ## [1.1.0] - 2020-04-26 116 | 117 | ### Added 118 | 119 | - Initial code 120 | 121 | ## [1.0.3] - 2019-12-30 from 188c4b 122 | 123 | ### Added 124 | 125 | - allFields property to form 126 | 127 | ### Changed 128 | 129 | - Fixed bug with undefined options.encoding 130 | - Updated dependencies 131 | 132 | ## [1.0.2] - 2017-06-20 133 | 134 | ### Changed 135 | 136 | - Update Coveralls badge in README.md 137 | - Updated dependencies 138 | 139 | ## [1.0.1] - 2017-06-20 140 | 141 | ### Added 142 | 143 | - appveyor 144 | - greenkeeper 145 | 146 | ### Changed 147 | 148 | - Updated dependencies 149 | 150 | ## [1.0.0] - 2018-09-30 151 | 152 | ### Added 153 | 154 | - File image.js 155 | - Handling of page encodings 156 | 157 | ### Changed 158 | 159 | - Updated README.md 160 | - Fixed tests 161 | - Updated dependencies 162 | - Fixed cookies 163 | 164 | ## [0.4.0] - 2017-11-12 165 | 166 | ### Added 167 | 168 | - Contributers to package.json and README.md 169 | - License to package.json 170 | - Support for Node.js 6 171 | 172 | ### Changed 173 | 174 | - Updated tests 175 | - Updated classes 176 | - Updated form 177 | - Fixed lint errors 178 | - Updated dependencies 179 | - Switch to use eslint 180 | 181 | ### Removed 182 | 183 | - File yarn.lock 184 | 185 | ## [0.3.0] - 2013-05-27 186 | 187 | ### Changed 188 | 189 | - Upgraded to Node.js 8 190 | 191 | ## [0.2.0] - 2013-05-27 192 | 193 | ### Changed 194 | 195 | - Upgraded to Node.js 0.10 196 | - Fix lint errors 197 | 198 | ## [0.1.0] - 2012-01-14 199 | 200 | ### Changed 201 | 202 | - Updated dependencies 203 | 204 | ## [0.0.7] - 2011-11-18 205 | 206 | ### Changed 207 | 208 | - Upgraded nodelint to version 0.5.2 209 | - Fixed lint errors 210 | 211 | ## [0.0.6] - 2011-09-13 212 | 213 | ### Changed 214 | 215 | - Updated format of package.json 216 | 217 | ## [0.0.5] - 2011-09-13 218 | 219 | ### Changed 220 | 221 | - Updated dependencies 222 | 223 | ## [0.0.4] - 2011-09-13 224 | 225 | ### Added 226 | 227 | - cookieJar to agent 228 | 229 | ## [0.0.3] - 2011-08-11 230 | 231 | ### Added 232 | 233 | - test/run.sh 234 | 235 | ## [0.0.2] - 2011-07-24 236 | 237 | ### Added 238 | 239 | - Initial code 240 | 241 | [1.5.0]: https://github.com/srveit/mechanize-js/compare/v1.4.1...v1.5.0 242 | [1.4.1]: https://github.com/srveit/mechanize-js/compare/v1.4.0...v1.4.1 243 | [1.4.0]: https://github.com/srveit/mechanize-js/compare/v1.3.0...v1.4.0 244 | [1.3.0]: https://github.com/srveit/mechanize-js/compare/v1.2.1...v1.3.0 245 | [1.2.1]: https://github.com/srveit/mechanize-js/compare/v1.2.0...v1.2.1 246 | [1.2.0]: https://github.com/srveit/mechanize-js/compare/v1.1.0...v1.2.0 247 | [1.1.0]: https://github.com/srveit/mechanize-js/compare/v1.0.3...v1.1.0 248 | [1.0.3]: https://github.com/srveit/mechanize-js/compare/v1.0.2...v1.0.3 249 | [1.0.2]: https://github.com/srveit/mechanize-js/compare/v1.0.1...v1.0.2 250 | [1.0.1]: https://github.com/srveit/mechanize-js/compare/v0.4.0...v1.0.1 251 | [0.4.0]: https://github.com/srveit/mechanize-js/compare/v0.3.0...v0.4.0 252 | [0.3.0]: https://github.com/srveit/mechanize-js/compare/v0.2.0...v0.3.0 253 | [0.2.0]: https://github.com/srveit/mechanize-js/compare/v0.1.0...v0.4.0 254 | [0.1.0]: https://github.com/srveit/mechanize-js/compare/v0.0.7...v0.1.0 255 | [0.0.7]: https://github.com/srveit/mechanize-js/compare/v0.0.6...v0.0.7 256 | [0.0.6]: https://github.com/srveit/mechanize-js/compare/v0.0.5...v0.0.6 257 | [0.0.5]: https://github.com/srveit/mechanize-js/compare/v0.0.4...v0.0.5 258 | [0.0.4]: https://github.com/srveit/mechanize-js/compare/v0.0.3...v0.0.4 259 | [0.0.3]: https://github.com/srveit/mechanize-js/compare/v0.0.2...v0.0.3 260 | [0.0.2]: https://github.com/srveit/mechanize-js/releases/tag/v0.0.2 261 | -------------------------------------------------------------------------------- /spec/helpers/mock-server.js: -------------------------------------------------------------------------------- 1 | import { URL } from 'url' 2 | import { types } from 'util' 3 | import { vi } from 'vitest' 4 | import { json, urlencoded } from 'body-parser' 5 | const express = require('express') 6 | 7 | const createMockServer = ({ 8 | name = 'server', 9 | rootPath = '', 10 | port, 11 | handlers = [], 12 | }) => { 13 | let server 14 | const serverName = name 15 | const mockHandlers = [] 16 | const environment = { 17 | SERVER_BASE_URL: '