Skip to content

Commit 8611066

Browse files
committed
fix(openator): update exposed methods and readme
1 parent 0d56254 commit 8611066

File tree

6 files changed

+158
-20
lines changed

6 files changed

+158
-20
lines changed

.readme/gui-demo.gif

7.02 MB
Loading

examples/basic/index.ts

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
import { initOpenator } from 'openator';
2+
3+
const main = async () => {
4+
if (!process.env.OPENAI_API_KEY) {
5+
throw new Error('OPENAI_API_KEY is not set');
6+
}
7+
8+
const openator = initOpenator({
9+
headless: false,
10+
openAiApiKey: process.env.OPENAI_API_KEY,
11+
});
12+
13+
const result =await openator.start(
14+
'https://amazon.com',
15+
'Find a black wirelesskeyboard and return the price.',
16+
);
17+
};
18+
19+
main();

examples/basic/package.json

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"name": "basic",
3+
"version": "1.0.0",
4+
"description": "",
5+
"license": "ISC",
6+
"author": "",
7+
"type": "commonjs",
8+
"main": "index.js",
9+
"scripts": {
10+
"test": "echo \"Error: no test specified\" && exit 1"
11+
},
12+
"dependencies": {
13+
"openator": "^1.0.1",
14+
"typescript": "^5.7.3"
15+
}
16+
}

examples/basic/tsconfig.json

+111
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
{
2+
"compilerOptions": {
3+
/* Visit https://aka.ms/tsconfig to read more about this file */
4+
5+
/* Projects */
6+
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
7+
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
8+
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
9+
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
10+
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
11+
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
12+
13+
/* Language and Environment */
14+
"target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
15+
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
16+
// "jsx": "preserve", /* Specify what JSX code is generated. */
17+
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
18+
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
19+
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
20+
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
21+
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
22+
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
23+
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
24+
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
25+
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
26+
27+
/* Modules */
28+
"module": "commonjs", /* Specify what module code is generated. */
29+
// "rootDir": "./", /* Specify the root folder within your source files. */
30+
// "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
31+
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
32+
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
33+
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
34+
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
35+
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
36+
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
37+
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
38+
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
39+
// "rewriteRelativeImportExtensions": true, /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */
40+
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
41+
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
42+
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
43+
// "noUncheckedSideEffectImports": true, /* Check side effect imports. */
44+
// "resolveJsonModule": true, /* Enable importing .json files. */
45+
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
46+
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
47+
48+
/* JavaScript Support */
49+
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
50+
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
51+
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
52+
53+
/* Emit */
54+
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
55+
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
56+
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
57+
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
58+
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
59+
// "noEmit": true, /* Disable emitting files from a compilation. */
60+
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
61+
// "outDir": "./", /* Specify an output folder for all emitted files. */
62+
// "removeComments": true, /* Disable emitting comments. */
63+
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
64+
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
65+
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
66+
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
67+
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
68+
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
69+
// "newLine": "crlf", /* Set the newline character for emitting files. */
70+
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
71+
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
72+
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
73+
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
74+
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
75+
76+
/* Interop Constraints */
77+
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
78+
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
79+
// "isolatedDeclarations": true, /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
80+
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
81+
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
82+
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
83+
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
84+
85+
/* Type Checking */
86+
"strict": true, /* Enable all strict type-checking options. */
87+
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
88+
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
89+
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
90+
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
91+
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
92+
// "strictBuiltinIteratorReturn": true, /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
93+
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
94+
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
95+
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
96+
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
97+
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
98+
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
99+
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
100+
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
101+
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
102+
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
103+
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
104+
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
105+
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
106+
107+
/* Completeness */
108+
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
109+
"skipLibCheck": true /* Skip type checking all .d.ts files. */
110+
}
111+
}

lib/README.md

+8-16
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="center">
2-
<a href="https://github.com/agentlabs-dev/openator"><img src="./.readme/cover.png" alt="Magic Inspector"></a>
2+
<a href="https://github.com/agentlabs-dev/openator"><img src="https://raw.githubusercontent.com/agentlabs-dev/openator/refs/heads/main/.readme/cover.png" alt="Openator"></a>
33
</p>
44

55
<p align="center">
@@ -40,7 +40,7 @@ This project is under active development and any help or support is welcome.
4040
Install the package and playwright using npm or yarn.
4141

4242
```bash
43-
npm i openator playwright
43+
npm i openator
4444
```
4545

4646
Spin up your first agent with a task.
@@ -50,11 +50,11 @@ import { initOpenator } from 'openator';
5050

5151
const main = async () => {
5252
const openator = initOpenator({
53-
headless: true,
53+
headless: false,
5454
openAiApiKey: process.env.OPENAI_API_KEY,
5555
});
5656

57-
await openator.launch(
57+
await openator.start(
5858
'https://amazon.com',
5959
'Find a black wirelesskeyboard and return the price.',
6060
);
@@ -63,24 +63,16 @@ const main = async () => {
6363
main();
6464
```
6565

66-
## Demos
66+
## Demo
6767

68-
We're also working on a web application that will allow you to interact with the agent directly. Here are some demos of what you can build with Openator.
68+
Here is what you can build with Openator, you can find more examples and source code in our main repository.
6969

70-
### GUI VERSION
71-
72-
https://github.com/user-attachments/assets/c197b6a3-05de-4e2d-8b61-b75668f92d6e
73-
74-
### CLI VERSION
75-
76-
Log in to my account with '[email protected]' and 'demopassword' and create a new test inside the Default Project. Once the test has been created, I can see the test editor.
77-
78-
https://github.com/user-attachments/assets/7873f6a8-89d5-4234-8a17-0d993f5dc5c7
70+
![Openator Demo](https://api.cloudflare.com/client/v4/accounts/b176d4f630c2d4e4a6fcf5ecc50a2e2d/images/v1/2ef38697-5e93-43ea-4289-c7d048d8bf00)
7971

8072
## How it works
8173

8274
<p align="center">
83-
<a href="https://magicinspector.com"><img src="./.readme/how-it-works.png" alt="agentlabs.dev"></a>
75+
<a href="#"><img src="https://raw.githubusercontent.com/agentlabs-dev/openator/refs/heads/main/.readme/how-it-works.png" alt="agentlabs.dev"></a>
8476
</p>
8577

8678
<p align="center">

lib/src/core/agents/openator/openator.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ export class Openator {
127127
return this.isSuccess || this.isFailure;
128128
}
129129

130-
async launch(
130+
async start(
131131
startUrl: string,
132132
initialPrompt: string,
133133
jobId?: string,
@@ -147,7 +147,7 @@ export class Openator {
147147
this.eventBus?.emit('run:update', this.currentRun);
148148
}
149149

150-
async run(jobId?: string): Promise<OpenatorResult> {
150+
private async run(jobId?: string): Promise<OpenatorResult> {
151151
return new Promise(async (resolve) => {
152152
this.reporter.loading('Starting manager agent');
153153

@@ -238,7 +238,7 @@ export class Openator {
238238
return actions.filter((action) => action.name !== 'triggerResult');
239239
}
240240

241-
async defineNextTask(): Promise<Task> {
241+
private async defineNextTask(): Promise<Task> {
242242
this.currentRun.think();
243243
this.emitRunUpdate();
244244

@@ -296,7 +296,7 @@ export class Openator {
296296
}
297297
}
298298

299-
async executeTask(task: Task) {
299+
private async executeTask(task: Task) {
300300
task.start();
301301

302302
await this.domService.resetHighlightElements();

0 commit comments

Comments
 (0)