Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/enncy/pioneerjs
pioneerjs - a puppeteer framework
https://github.com/enncy/pioneerjs
automated framework headless-chrome nodejs pioneerjs puppeteer puppeteer-core typescript web
Last synced: about 2 months ago
JSON representation
pioneerjs - a puppeteer framework
- Host: GitHub
- URL: https://github.com/enncy/pioneerjs
- Owner: enncy
- License: apache-2.0
- Created: 2021-07-06T11:18:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-10-24T13:15:16.000Z (about 3 years ago)
- Last Synced: 2024-04-26T05:44:34.324Z (8 months ago)
- Topics: automated, framework, headless-chrome, nodejs, pioneerjs, puppeteer, puppeteer-core, typescript, web
- Language: TypeScript
- Homepage:
- Size: 856 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pioneerjs
pioneerjs - a puppeteer framework
>Pioneerjs is a puppeteer framework that uses the principle of Dependency Injection to inject all the resources(page,browser,...) you need.
- Pioneerjs helps you to manage the `Browser` and `Page` objects of Puppeteer
- It instantiates and automatically injects Page, Browser, ScriptContext objects for each runnable script
- You can use RunnableScript to run the puppeteer code and start it with @Runnable('https://xxx.com') decorator
- You can use InjectableScripts in any RunnableScript and inject them automatically using the @Inject decorator, no instantiation is needed, the Page, Browser, ScriptContext objects of an InjectableScript are the same as in the RunnableScript it is in, and InjectableScripts generally play the role of tool scripts
## Getting Started
```bash
# init your package.json
npm init
```
```bash
# install dependencies
npm install puppeteer-core @pioneerjs/core @pioneerjs/common
# or you can just install pioneerjs
npm install puppeteer-core pioneerjs
```
```bash
# init typescript config
tsc --init
```
`tscondig.json`
```json
{
"compilerOptions": {
"target": "es5",
"module": "commonjs",
"outDir": "./dist",
"strict": true,
"esModuleInterop": true,
"experimentalDecorators": true,
"emitDecoratorMetadata": true,
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true
}
}
```
create `app.ts`
```typescript
import { PioneerFactory } from "@pioneerjs/core";
import { TestScript } from "./src/test";
PioneerFactory.launch({
// your chrome path
executablePath: "C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe",
defaultViewport: null,
headless: false,
}).then(async pioneer => {
pioneer.startup({
scripts: [TestScript],
events: ['request']
})
// or you can find script by name
const { runnanleScripts } = await pioneer.startup({
scripts: [TestScript],
events: ['request']
})
runnanleScripts?.find(s=>s.name="TestScript").run()
})
```
create `src/test.ts`
```typescript
import { Injectable, Runnable, Inject } from "@pioneerjs/common";
import { InjectableScript, RunnableScript, WaitForScript } from "@pioneerjs/core";
import { Protocol } from "puppeteer-core";
// create your new script
@Injectable()
export class Spider extends InjectableScript {
async getCookie(url: string): Promise {
await this.page.goto(url)
return await this.page.cookies()
}
}
/**
* create a new runnable script
* @Runnable({url:"https://baidu.com"}) // goto "https://baidu.com"
* or
* @Runnable() // do nothing
*/
@Runnable()
export class TestScript extends RunnableScript {
@Inject()
private mySpider!: Spider ;
@Inject()
private waitFor!: WaitForScript ;
async run(): Promise {
console.log(await this.mySpider.getCookie("https://baidu.com")); // ...
console.log("waidForSleep");
// auto inject you don't need to instance
this.waitFor.sleep(3000)
console.log(this.waitFor.page.url());
// InjectableScript use same page,and context with RunnableScript
console.log(this.waitFor.page === this.page);
// eventPool: catch all the event
console.log(this.context.eventPool.getEvents('request')?.length)
// Script communication
this.context.store.set('say', 'hello word')
console.log(this.waitFor.context.store.get('say'))
}
// called when document change
async update(): Promise {
console.log("update", this.page.url());
}
}
```
```bash
# build your project
tsc
# run
node dist/index.js
```
out put like this :
```
[pioneerjs]:script injected - TestScript.Spider
[pioneerjs]:script injected - TestScript.WaitForScript
[pioneerjs]:script running - TestScript
[
xxx
]
waidForSleep
https://www.baidu.com/
true
43
hello word
update https://www.baidu.com/
```