@rpascene/shared 0.30.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (177) hide show
  1. package/README.md +9 -0
  2. package/dist/es/baseDB.mjs +109 -0
  3. package/dist/es/build/copy-static.mjs +29 -0
  4. package/dist/es/common.mjs +37 -0
  5. package/dist/es/constants/example-code.mjs +202 -0
  6. package/dist/es/constants/index.mjs +74 -0
  7. package/dist/es/env/basic.mjs +6 -0
  8. package/dist/es/env/constants.mjs +97 -0
  9. package/dist/es/env/decide-model-config.mjs +172 -0
  10. package/dist/es/env/global-config-manager.mjs +82 -0
  11. package/dist/es/env/helper.mjs +45 -0
  12. package/dist/es/env/index.mjs +5 -0
  13. package/dist/es/env/init-debug.mjs +18 -0
  14. package/dist/es/env/model-config-manager.mjs +99 -0
  15. package/dist/es/env/parse.mjs +69 -0
  16. package/dist/es/env/types.mjs +265 -0
  17. package/dist/es/env/utils.mjs +18 -0
  18. package/dist/es/extractor/constants.mjs +2 -0
  19. package/dist/es/extractor/cs_postmessage.mjs +61 -0
  20. package/dist/es/extractor/customLocator.mjs +646 -0
  21. package/dist/es/extractor/debug.mjs +6 -0
  22. package/dist/es/extractor/dom-util.mjs +92 -0
  23. package/dist/es/extractor/index.mjs +7 -0
  24. package/dist/es/extractor/locator.mjs +95 -0
  25. package/dist/es/extractor/tree.mjs +81 -0
  26. package/dist/es/extractor/util.mjs +244 -0
  27. package/dist/es/extractor/web-extractor.mjs +361 -0
  28. package/dist/es/img/box-select.mjs +184 -0
  29. package/dist/es/img/draw-box.mjs +42 -0
  30. package/dist/es/img/get-jimp.mjs +10 -0
  31. package/dist/es/img/get-photon.mjs +19 -0
  32. package/dist/es/img/get-sharp.mjs +11 -0
  33. package/dist/es/img/index.mjs +5 -0
  34. package/dist/es/img/info.mjs +32 -0
  35. package/dist/es/img/transform.mjs +192 -0
  36. package/dist/es/index.mjs +3 -0
  37. package/dist/es/logger.mjs +61 -0
  38. package/dist/es/node/fs.mjs +44 -0
  39. package/dist/es/node/index.mjs +1 -0
  40. package/dist/es/polyfills/async-hooks.mjs +2 -0
  41. package/dist/es/polyfills/index.mjs +1 -0
  42. package/dist/es/types/index.mjs +3 -0
  43. package/dist/es/us-keyboard-layout.mjs +1414 -0
  44. package/dist/es/us-keyboard-layout.mjs.LICENSE.txt +5 -0
  45. package/dist/es/utils.mjs +66 -0
  46. package/dist/lib/baseDB.js +149 -0
  47. package/dist/lib/build/copy-static.js +77 -0
  48. package/dist/lib/common.js +93 -0
  49. package/dist/lib/constants/example-code.js +239 -0
  50. package/dist/lib/constants/index.js +153 -0
  51. package/dist/lib/env/basic.js +40 -0
  52. package/dist/lib/env/constants.js +143 -0
  53. package/dist/lib/env/decide-model-config.js +212 -0
  54. package/dist/lib/env/global-config-manager.js +116 -0
  55. package/dist/lib/env/helper.js +85 -0
  56. package/dist/lib/env/index.js +94 -0
  57. package/dist/lib/env/init-debug.js +52 -0
  58. package/dist/lib/env/model-config-manager.js +133 -0
  59. package/dist/lib/env/parse.js +106 -0
  60. package/dist/lib/env/types.js +650 -0
  61. package/dist/lib/env/utils.js +61 -0
  62. package/dist/lib/extractor/constants.js +42 -0
  63. package/dist/lib/extractor/cs_postmessage.js +98 -0
  64. package/dist/lib/extractor/customLocator.js +698 -0
  65. package/dist/lib/extractor/debug.js +12 -0
  66. package/dist/lib/extractor/dom-util.js +150 -0
  67. package/dist/lib/extractor/index.js +153 -0
  68. package/dist/lib/extractor/locator.js +141 -0
  69. package/dist/lib/extractor/tree.js +127 -0
  70. package/dist/lib/extractor/util.js +335 -0
  71. package/dist/lib/extractor/web-extractor.js +407 -0
  72. package/dist/lib/img/box-select.js +232 -0
  73. package/dist/lib/img/draw-box.js +89 -0
  74. package/dist/lib/img/get-jimp.js +72 -0
  75. package/dist/lib/img/get-photon.js +76 -0
  76. package/dist/lib/img/get-sharp.js +63 -0
  77. package/dist/lib/img/index.js +102 -0
  78. package/dist/lib/img/info.js +86 -0
  79. package/dist/lib/img/transform.js +279 -0
  80. package/dist/lib/index.js +43 -0
  81. package/dist/lib/logger.js +114 -0
  82. package/dist/lib/node/fs.js +97 -0
  83. package/dist/lib/node/index.js +60 -0
  84. package/dist/lib/polyfills/async-hooks.js +36 -0
  85. package/dist/lib/polyfills/index.js +60 -0
  86. package/dist/lib/types/index.js +37 -0
  87. package/dist/lib/us-keyboard-layout.js +1457 -0
  88. package/dist/lib/us-keyboard-layout.js.LICENSE.txt +5 -0
  89. package/dist/lib/utils.js +136 -0
  90. package/dist/types/baseDB.d.ts +25 -0
  91. package/dist/types/build/copy-static.d.ts +31 -0
  92. package/dist/types/common.d.ts +12 -0
  93. package/dist/types/constants/example-code.d.ts +2 -0
  94. package/dist/types/constants/index.d.ts +23 -0
  95. package/dist/types/env/basic.d.ts +6 -0
  96. package/dist/types/env/constants.d.ts +40 -0
  97. package/dist/types/env/decide-model-config.d.ts +14 -0
  98. package/dist/types/env/global-config-manager.d.ts +32 -0
  99. package/dist/types/env/helper.d.ts +6 -0
  100. package/dist/types/env/index.d.ts +4 -0
  101. package/dist/types/env/init-debug.d.ts +1 -0
  102. package/dist/types/env/model-config-manager.d.ts +24 -0
  103. package/dist/types/env/parse.d.ts +12 -0
  104. package/dist/types/env/types.d.ts +295 -0
  105. package/dist/types/env/utils.d.ts +7 -0
  106. package/dist/types/extractor/constants.d.ts +1 -0
  107. package/dist/types/extractor/cs_postmessage.d.ts +2 -0
  108. package/dist/types/extractor/customLocator.d.ts +69 -0
  109. package/dist/types/extractor/debug.d.ts +1 -0
  110. package/dist/types/extractor/dom-util.d.ts +26 -0
  111. package/dist/types/extractor/index.d.ts +36 -0
  112. package/dist/types/extractor/locator.d.ts +7 -0
  113. package/dist/types/extractor/tree.d.ts +9 -0
  114. package/dist/types/extractor/util.d.ts +43 -0
  115. package/dist/types/extractor/web-extractor.d.ts +19 -0
  116. package/dist/types/img/box-select.d.ts +25 -0
  117. package/dist/types/img/draw-box.d.ts +15 -0
  118. package/dist/types/img/get-jimp.d.ts +2 -0
  119. package/dist/types/img/get-photon.d.ts +8 -0
  120. package/dist/types/img/get-sharp.d.ts +3 -0
  121. package/dist/types/img/index.d.ts +4 -0
  122. package/dist/types/img/info.d.ts +29 -0
  123. package/dist/types/img/transform.d.ts +88 -0
  124. package/dist/types/index.d.ts +3 -0
  125. package/dist/types/logger.d.ts +4 -0
  126. package/dist/types/node/fs.d.ts +15 -0
  127. package/dist/types/node/index.d.ts +1 -0
  128. package/dist/types/polyfills/async-hooks.d.ts +6 -0
  129. package/dist/types/polyfills/index.d.ts +4 -0
  130. package/dist/types/types/index.d.ts +37 -0
  131. package/dist/types/us-keyboard-layout.d.ts +32 -0
  132. package/dist/types/utils.d.ts +22 -0
  133. package/package.json +102 -0
  134. package/src/baseDB.ts +158 -0
  135. package/src/build/copy-static.ts +62 -0
  136. package/src/common.ts +67 -0
  137. package/src/constants/example-code.ts +202 -0
  138. package/src/constants/index.ts +81 -0
  139. package/src/env/basic.ts +12 -0
  140. package/src/env/constants.ts +291 -0
  141. package/src/env/decide-model-config.ts +319 -0
  142. package/src/env/global-config-manager.ts +174 -0
  143. package/src/env/helper.ts +80 -0
  144. package/src/env/index.ts +4 -0
  145. package/src/env/init-debug.ts +29 -0
  146. package/src/env/model-config-manager.ts +145 -0
  147. package/src/env/parse.ts +131 -0
  148. package/src/env/types.ts +573 -0
  149. package/src/env/utils.ts +39 -0
  150. package/src/extractor/constants.ts +5 -0
  151. package/src/extractor/cs_postmessage.ts +101 -0
  152. package/src/extractor/customLocator.ts +1138 -0
  153. package/src/extractor/debug.ts +10 -0
  154. package/src/extractor/dom-util.ts +141 -0
  155. package/src/extractor/index.ts +54 -0
  156. package/src/extractor/locator.ts +179 -0
  157. package/src/extractor/tree.ts +179 -0
  158. package/src/extractor/util.ts +468 -0
  159. package/src/extractor/web-extractor.ts +559 -0
  160. package/src/img/box-select.ts +346 -0
  161. package/src/img/draw-box.ts +60 -0
  162. package/src/img/get-jimp.ts +12 -0
  163. package/src/img/get-photon.ts +48 -0
  164. package/src/img/get-sharp.ts +18 -0
  165. package/src/img/index.ts +24 -0
  166. package/src/img/info.ts +79 -0
  167. package/src/img/jimp.d.ts +4 -0
  168. package/src/img/transform.ts +396 -0
  169. package/src/index.ts +6 -0
  170. package/src/logger.ts +93 -0
  171. package/src/node/fs.ts +84 -0
  172. package/src/node/index.ts +1 -0
  173. package/src/polyfills/async-hooks.ts +6 -0
  174. package/src/polyfills/index.ts +4 -0
  175. package/src/types/index.ts +53 -0
  176. package/src/us-keyboard-layout.ts +723 -0
  177. package/src/utils.ts +127 -0
package/README.md ADDED
@@ -0,0 +1,9 @@
1
+ ## Documentation
2
+
3
+ An AI-powered automation SDK can control the page, perform assertions, and extract data in JSON format using natural language.
4
+
5
+ See https://rpascenejs.com/ for details.
6
+
7
+ ## License
8
+
9
+ Rpascene is MIT licensed.
@@ -0,0 +1,109 @@
1
+ function _define_property(obj, key, value) {
2
+ if (key in obj) Object.defineProperty(obj, key, {
3
+ value: value,
4
+ enumerable: true,
5
+ configurable: true,
6
+ writable: true
7
+ });
8
+ else obj[key] = value;
9
+ return obj;
10
+ }
11
+ class IndexedDBManager {
12
+ initDB() {
13
+ return new Promise((resolve, reject)=>{
14
+ const request = indexedDB.open(this.dbName, this.version);
15
+ request.onerror = ()=>reject(request.error);
16
+ request.onsuccess = ()=>resolve(request.result);
17
+ request.onupgradeneeded = (event)=>{
18
+ const db = event.target.result;
19
+ this.storeConfigs.forEach(({ name, keyPath })=>{
20
+ if (!db.objectStoreNames.contains(name)) {
21
+ const store = db.createObjectStore(name, {
22
+ keyPath
23
+ });
24
+ store.createIndex('timestamp', 'timestamp', {
25
+ unique: false
26
+ });
27
+ }
28
+ });
29
+ };
30
+ });
31
+ }
32
+ async withTransaction(storeNames, mode, operation) {
33
+ const db = await this.dbPromise;
34
+ const transaction = db.transaction(storeNames, mode);
35
+ const stores = Array.isArray(storeNames) ? storeNames.map((name)=>transaction.objectStore(name)) : transaction.objectStore(storeNames);
36
+ return operation(stores);
37
+ }
38
+ promisifyRequest(request) {
39
+ return new Promise((resolve, reject)=>{
40
+ request.onsuccess = ()=>resolve(request.result);
41
+ request.onerror = ()=>reject(request.error);
42
+ });
43
+ }
44
+ async put(storeName, data) {
45
+ await this.withTransaction(storeName, 'readwrite', async (store)=>{
46
+ await this.promisifyRequest(store.put(data));
47
+ });
48
+ }
49
+ async get(storeName, key) {
50
+ return this.withTransaction(storeName, 'readonly', async (store)=>this.promisifyRequest(store.get(key)));
51
+ }
52
+ async getAll(storeName, sortByTimestamp = true) {
53
+ return this.withTransaction(storeName, 'readonly', async (store)=>{
54
+ const objectStore = store;
55
+ const results = sortByTimestamp ? await this.promisifyRequest(objectStore.index('timestamp').getAll()) : await this.promisifyRequest(objectStore.getAll());
56
+ return sortByTimestamp ? results.sort((a, b)=>a.timestamp - b.timestamp) : results;
57
+ });
58
+ }
59
+ async clear(storeName) {
60
+ await this.withTransaction(storeName, 'readwrite', async (store)=>{
61
+ await this.promisifyRequest(store.clear());
62
+ });
63
+ }
64
+ async delete(storeName, key) {
65
+ await this.withTransaction(storeName, 'readwrite', async (store)=>{
66
+ await this.promisifyRequest(store.delete(key));
67
+ });
68
+ }
69
+ async count(storeName) {
70
+ return this.withTransaction(storeName, 'readonly', async (store)=>this.promisifyRequest(store.count()));
71
+ }
72
+ getDBPromise() {
73
+ return this.dbPromise;
74
+ }
75
+ constructor(dbName, version, storeConfigs){
76
+ _define_property(this, "dbPromise", void 0);
77
+ _define_property(this, "dbName", void 0);
78
+ _define_property(this, "version", void 0);
79
+ _define_property(this, "storeConfigs", void 0);
80
+ this.dbName = dbName;
81
+ this.version = version;
82
+ this.storeConfigs = storeConfigs;
83
+ this.dbPromise = this.initDB();
84
+ }
85
+ }
86
+ const withErrorHandling = async (operation, errorMessage, defaultValue, onQuotaExceeded)=>{
87
+ try {
88
+ return await operation();
89
+ } catch (e) {
90
+ console.error(errorMessage, e);
91
+ if (e instanceof Error && 'QuotaExceededError' === e.name && onQuotaExceeded) {
92
+ console.log('Storage quota exceeded, running cleanup...');
93
+ await onQuotaExceeded();
94
+ }
95
+ return defaultValue;
96
+ }
97
+ };
98
+ const createCleanupFunction = (dbManager, storeName, maxItems)=>async ()=>{
99
+ try {
100
+ const results = await dbManager.getAll(storeName);
101
+ if (results.length > maxItems) {
102
+ const toDelete = results.sort((a, b)=>a.timestamp - b.timestamp).slice(0, results.length - maxItems);
103
+ await Promise.all(toDelete.map((item)=>dbManager.delete(storeName, item.id)));
104
+ }
105
+ } catch (e) {
106
+ console.error(`Failed to cleanup ${storeName}:`, e);
107
+ }
108
+ };
109
+ export { IndexedDBManager, createCleanupFunction, withErrorHandling };
@@ -0,0 +1,29 @@
1
+ import node_fs from "node:fs";
2
+ import node_path from "node:path";
3
+ const createCopyStaticPlugin = (options)=>({
4
+ name: options.pluginName || 'copy-static',
5
+ setup (api) {
6
+ api.onAfterBuild(async ()=>{
7
+ const { srcDir, destDir, faviconPath } = options;
8
+ await node_fs.promises.mkdir(destDir, {
9
+ recursive: true
10
+ });
11
+ await node_fs.promises.cp(srcDir, destDir, {
12
+ recursive: true
13
+ });
14
+ console.log(`Copied build artifacts from ${srcDir} to ${destDir}`);
15
+ if (faviconPath) {
16
+ const faviconDest = node_path.join(destDir, 'favicon.ico');
17
+ await node_fs.promises.copyFile(faviconPath, faviconDest);
18
+ console.log(`Copied favicon from ${faviconPath} to ${faviconDest}`);
19
+ }
20
+ });
21
+ }
22
+ });
23
+ const createPlaygroundCopyPlugin = (srcDir, destDir, pluginName, faviconSrc)=>createCopyStaticPlugin({
24
+ srcDir,
25
+ destDir,
26
+ faviconPath: faviconSrc,
27
+ pluginName
28
+ });
29
+ export { createCopyStaticPlugin, createPlaygroundCopyPlugin };
@@ -0,0 +1,37 @@
1
+ import { existsSync, mkdirSync } from "node:fs";
2
+ import { tmpdir } from "node:os";
3
+ import node_path from "node:path";
4
+ import { getBasicEnvValue } from "./env/basic.mjs";
5
+ import { RPASCENE_RUN_DIR } from "./env/types.mjs";
6
+ import { ifInNode } from "./utils.mjs";
7
+ const defaultRunDirName = 'rpascene_run';
8
+ const getRpasceneRunDir = ()=>{
9
+ if (!ifInNode) return '';
10
+ return getBasicEnvValue(RPASCENE_RUN_DIR) || defaultRunDirName;
11
+ };
12
+ const getRpasceneRunBaseDir = ()=>{
13
+ if (!ifInNode) return '';
14
+ let basePath = node_path.resolve(process.cwd(), getRpasceneRunDir());
15
+ if (!existsSync(basePath)) try {
16
+ mkdirSync(basePath, {
17
+ recursive: true
18
+ });
19
+ } catch (error) {
20
+ basePath = node_path.join(tmpdir(), defaultRunDirName);
21
+ mkdirSync(basePath, {
22
+ recursive: true
23
+ });
24
+ }
25
+ return basePath;
26
+ };
27
+ const getRpasceneRunSubDir = (subdir)=>{
28
+ if (!ifInNode) return '';
29
+ const basePath = getRpasceneRunBaseDir();
30
+ const logPath = node_path.join(basePath, subdir);
31
+ if (!existsSync(logPath)) mkdirSync(logPath, {
32
+ recursive: true
33
+ });
34
+ return logPath;
35
+ };
36
+ const ERROR_CODE_NOT_IMPLEMENTED_AS_DESIGNED = 'NOT_IMPLEMENTED_AS_DESIGNED';
37
+ export { ERROR_CODE_NOT_IMPLEMENTED_AS_DESIGNED, defaultRunDirName, getRpasceneRunBaseDir, getRpasceneRunDir, getRpasceneRunSubDir };
@@ -0,0 +1,202 @@
1
+ const PLAYWRIGHT_EXAMPLE_CODE = `
2
+ // Reference the following code to generate Rpascene test cases
3
+ // The following is test code for Rpascene AI, for reference
4
+ // The following is Playwright syntax, you can use Playwright to assist in test generation
5
+ IMPORTANT: Follow these exact type signatures for AI functions:
6
+
7
+ // Type signatures for AI functions:
8
+ aiInput(value: string, locator: string): Promise<void>
9
+ aiTap(locator: string): Promise<void>
10
+ aiDoubleClick(locator: string): Promise<void>
11
+ aiScroll(scrollParam: {
12
+ direction: 'up' | 'down' | 'left' | 'right',
13
+ scrollType: 'once' | 'untilBottom' | 'untilTop' | 'untilRight' | 'untilLeft',
14
+ distance: number - scroll distance, px is the unit
15
+ }): Promise<void>
16
+ aiAssert(assertion: string): Promise<void>
17
+ aiQuery<T>(queryObject: Record<string, string>): Promise<T> // Extracts data from page based on descriptions
18
+
19
+ // examples:
20
+ // Reference the following code to generate Rpascene test cases
21
+ // The following is test code for Rpascene AI, for reference
22
+ // The following is Playwright syntax, you can use Playwright to assist in test generation
23
+ import { test as base } from '@playwright/test';
24
+ import type { PlayWrightAiFixtureType } from '@rpascene/web/playwright';
25
+ import { PlaywrightAiFixture } from '@rpascene/web/playwright';
26
+
27
+ const test = base.extend<PlayWrightAiFixtureType>(PlaywrightAiFixture({
28
+ waitForNetworkIdleTimeout: 2000, // optional, the timeout for waiting for network idle between each action, default is 2000ms
29
+ }));
30
+
31
+
32
+ test.beforeEach(async ({ page }) => {
33
+ await page.goto('https://www.xxx.com/');
34
+ await page.setViewportSize({ width: 1920, height: 1080 });
35
+ });
36
+
37
+ test('ai shop', async ({
38
+ aiInput,
39
+ aiAssert,
40
+ aiQuery,
41
+ aiKeyboardPress,
42
+ aiHover,
43
+ aiTap,
44
+ agentForPage,
45
+ page,
46
+ }) => {
47
+ // login
48
+ await aiAssert('The page shows the login interface');
49
+ await aiInput('user_name', 'in user name input');
50
+ await aiInput('password', 'in password input');
51
+ await aiKeyboardPress('Enter', 'Login Button');
52
+
53
+ // check the login success
54
+ await aiWaitFor('The page shows that the loading is complete');
55
+ await aiAssert('The current page shows the product detail page');
56
+
57
+ // check the product info
58
+ const dataA = await aiQuery({
59
+ userInfo: 'User information in the format {name: string}',
60
+ theFirstProductInfo: 'The first product info in the format {name: string, price: number}',
61
+ });
62
+ expect(dataA.theFirstProductInfo.name).toBe('xxx');
63
+ expect(dataA.theFirstProductInfo.price).toBe(100);
64
+
65
+
66
+ // add to cart
67
+ await aiTap('click add to cart button');
68
+
69
+ await aiTap('click right top cart icon');
70
+ await aiAssert('The cart icon shows the number 1');
71
+ });
72
+ `;
73
+ const YAML_EXAMPLE_CODE = `
74
+ 1. Format:
75
+
76
+ web:
77
+ url: "starting_url"
78
+ viewportWidth: 1280
79
+ viewportHeight: 960
80
+
81
+ tasks:
82
+ - name: "descriptive task name"
83
+ flow:
84
+ - aiTap: "element description"
85
+ - aiInput: 'text value'
86
+ locate: 'input field description'
87
+ - aiScroll:
88
+ direction: down/up
89
+ scrollType: untilBottom/untilTop/page
90
+ - aiAssert: "expected state"
91
+ - sleep: milliseconds
92
+
93
+ 2. Action Types:
94
+ - aiTap: for clicks (natural language targeting)
95
+ - aiInput: for text input with 'locate' field
96
+ - aiScroll: with direction and scrollType
97
+ - aiAssert: for validations
98
+ - sleep: for delays (milliseconds)
99
+
100
+ 3. Best Practices:
101
+ - Group related actions into logical tasks
102
+ - Use natural language descriptions
103
+ - Add deepThink: true for complex interactions
104
+ - Keep task names concise but descriptive
105
+
106
+
107
+
108
+ YAML type
109
+ tasks:
110
+ - name: <name>
111
+ continueOnError: <boolean> # Optional, whether to continue to the next task on error, defaults to false.
112
+ flow:
113
+ # Auto Planning (.ai)
114
+ # ----------------
115
+
116
+ # Perform an interaction. \`ai\` is a shorthand for \`aiAction\`.
117
+ - ai: <prompt>
118
+ cacheable: <boolean> # Optional, whether to cache the result of this API call when the [caching feature](./caching.mdx) is enabled. Defaults to True.
119
+
120
+ # This usage is the same as \`ai\`.
121
+ - aiAction: <prompt>
122
+ cacheable: <boolean> # Optional, whether to cache the result of this API call when the [caching feature](./caching.mdx) is enabled. Defaults to True.
123
+
124
+ # Instant Action (.aiTap, .aiDoubleClick, .aiHover, .aiInput, .aiKeyboardPress, .aiScroll)
125
+ # ----------------
126
+
127
+ # Tap an element described by a prompt.
128
+ - aiTap: <prompt>
129
+ deepThink: <boolean> # Optional, whether to use deepThink to precisely locate the element. Defaults to False.
130
+ xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Rpascene will prioritize this xpath to find the element before using the cache and the AI model. Defaults to empty.
131
+ cacheable: <boolean> # Optional, whether to cache the result of this API call when the [caching feature](./caching.mdx) is enabled. Defaults to True.
132
+
133
+ # Double click an element described by a prompt.
134
+ - aiDoubleClick: <prompt>
135
+ deepThink: <boolean> # Optional, whether to use deepThink to precisely locate the element. Defaults to False.
136
+ xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Rpascene will prioritize this xpath to find the element before using the cache and the AI model. Defaults to empty.
137
+ cacheable: <boolean> # Optional, whether to cache the result of this API call when the [caching feature](./caching.mdx) is enabled. Defaults to True.
138
+
139
+ # Hover over an element described by a prompt.
140
+ - aiHover: <prompt>
141
+ deepThink: <boolean> # Optional, whether to use deepThink to precisely locate the element. Defaults to False.
142
+ xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Rpascene will prioritize this xpath to find the element before using the cache and the AI model. Defaults to empty.
143
+ cacheable: <boolean> # Optional, whether to cache the result of this API call when the [caching feature](./caching.mdx) is enabled. Defaults to True.
144
+
145
+ # Input text into an element described by a prompt.
146
+ - aiInput: <final text content of the input>
147
+ locate: <prompt>
148
+ deepThink: <boolean> # Optional, whether to use deepThink to precisely locate the element. Defaults to False.
149
+ xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Rpascene will prioritize this xpath to find the element before using the cache and the AI model. Defaults to empty.
150
+ cacheable: <boolean> # Optional, whether to cache the result of this API call when the [caching feature](./caching.mdx) is enabled. Defaults to True.
151
+
152
+ # Press a key (e.g., Enter, Tab, Escape) on an element described by a prompt.
153
+ - aiKeyboardPress: <key>
154
+ locate: <prompt>
155
+ deepThink: <boolean> # Optional, whether to use deepThink to precisely locate the element. Defaults to False.
156
+ xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Rpascene will prioritize this xpath to find the element before using the cache and the AI model. Defaults to empty.
157
+ cacheable: <boolean> # Optional, whether to cache the result of this API call when the [caching feature](./caching.mdx) is enabled. Defaults to True.
158
+
159
+ # Scroll globally or on an element described by a prompt.
160
+ - aiScroll:
161
+ direction: 'up' # or 'down' | 'left' | 'right'
162
+ scrollType: 'once' # or 'untilTop' | 'untilBottom' | 'untilLeft' | 'untilRight'
163
+ distance: <number> # Optional, the scroll distance in pixels.
164
+ locate: <prompt> # Optional, the element to scroll on.
165
+ deepThink: <boolean> # Optional, whether to use deepThink to precisely locate the element. Defaults to False.
166
+ xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Rpascene will prioritize this xpath to find the element before using the cache and the AI model. Defaults to empty.
167
+ cacheable: <boolean> # Optional, whether to cache the result of this API call when the [caching feature](./caching.mdx) is enabled. Defaults to True.
168
+
169
+ # Log the current screenshot with a description in the report file.
170
+ - logScreenshot: <title> # Optional, the title of the screenshot. If not provided, the title will be 'untitled'.
171
+ content: <content> # Optional, the description of the screenshot.
172
+
173
+ # Data Extraction
174
+ # ----------------
175
+
176
+ # Perform a query that returns a JSON object.
177
+ - aiQuery: <prompt> # Remember to describe the format of the result in the prompt.
178
+ name: <name> # The key for the query result in the JSON output.
179
+
180
+ # More APIs
181
+ # ----------------
182
+
183
+ # Wait for a condition to be met, with a timeout (in ms, optional, defaults to 30000).
184
+ - aiWaitFor: <prompt>
185
+ timeout: <ms>
186
+
187
+ # Perform an assertion.
188
+ - aiAssert: <prompt>
189
+ errorMessage: <error-message> # Optional, the error message to print if the assertion fails.
190
+
191
+ # Wait for a specified amount of time.
192
+ - sleep: <ms>
193
+
194
+ # Execute a piece of JavaScript code in the web page context.
195
+ - javascript: <javascript>
196
+ name: <name> # Optional, assign a name to the return value, which will be used as a key in the JSON output.
197
+
198
+ - name: <name>
199
+ flow:
200
+ # ...
201
+ `;
202
+ export { PLAYWRIGHT_EXAMPLE_CODE, YAML_EXAMPLE_CODE };
@@ -0,0 +1,74 @@
1
+ import { PLAYWRIGHT_EXAMPLE_CODE, YAML_EXAMPLE_CODE } from "./example-code.mjs";
2
+ const TEXT_SIZE_THRESHOLD = 9;
3
+ const TEXT_MAX_SIZE = 40;
4
+ const CONTAINER_MINI_HEIGHT = 3;
5
+ const CONTAINER_MINI_WIDTH = 3;
6
+ var constants_NodeType = /*#__PURE__*/ function(NodeType) {
7
+ NodeType["CONTAINER"] = "CONTAINER Node";
8
+ NodeType["FORM_ITEM"] = "FORM_ITEM Node";
9
+ NodeType["BUTTON"] = "BUTTON Node";
10
+ NodeType["A"] = "Anchor Node";
11
+ NodeType["IMG"] = "IMG Node";
12
+ NodeType["TEXT"] = "TEXT Node";
13
+ NodeType["POSITION"] = "POSITION Node";
14
+ return NodeType;
15
+ }({});
16
+ const PLAYGROUND_SERVER_PORT = 5800;
17
+ const SCRCPY_SERVER_PORT = 5700;
18
+ const WEBDRIVER_ELEMENT_ID_KEY = 'element-6066-11e4-a52e-4f735466cecf';
19
+ const DEFAULT_WDA_PORT = 8100;
20
+ const DEFAULT_WAIT_FOR_NAVIGATION_TIMEOUT = 5000;
21
+ const DEFAULT_WAIT_FOR_NETWORK_IDLE_TIMEOUT = 2000;
22
+ const DEFAULT_WAIT_FOR_NETWORK_IDLE_TIME = 300;
23
+ const DEFAULT_WAIT_FOR_NETWORK_IDLE_CONCURRENCY = 2;
24
+ const commandMap = {
25
+ Tap: {
26
+ CommandName: "SeleniumClickCommand",
27
+ DisplayName: "\u5143\u7D20\u70B9\u51FB"
28
+ },
29
+ RightClick: {
30
+ CommandName: "SeleniumRightClickCommand",
31
+ DisplayName: "\u5143\u7D20\u53F3\u952E\u70B9\u51FB"
32
+ },
33
+ DoubleClick: {
34
+ CommandName: "SeleniumDoubleClickCommand",
35
+ DisplayName: "\u5143\u7D20\u53CC\u51FB"
36
+ },
37
+ Hover: {
38
+ CommandName: "SeleniumMouseHoverCommand",
39
+ DisplayName: "\u9F20\u6807\u60AC\u505C"
40
+ },
41
+ Input: {
42
+ CommandName: "SeleniumSetTextCommand",
43
+ DisplayName: "\u8BBE\u7F6E\u6587\u672C"
44
+ },
45
+ KeyboardPress: {
46
+ CommandName: "SeleniumSendKeysCommand",
47
+ DisplayName: "\u6A21\u62DF\u6309\u952E"
48
+ },
49
+ Scroll: {
50
+ CommandName: "SeleniumElementScrollCommand",
51
+ DisplayName: "\u5143\u7D20\u6EDA\u52A8"
52
+ },
53
+ DragAndDrop: {
54
+ CommandName: "SeleniumDragDropCommand",
55
+ DisplayName: "\u5143\u7D20\u62D6\u62FD\uFF08\u81F3\u6307\u5B9A\u5143\u7D20\uFF09"
56
+ },
57
+ ClearInput: {
58
+ CommandName: "SeleniumClearTextCommand",
59
+ DisplayName: "\u6E05\u7A7A\u6587\u672C"
60
+ },
61
+ Sleep: {
62
+ CommandName: "SeleniumPauseCommand",
63
+ DisplayName: "\u6682\u505C\u811A\u672C"
64
+ },
65
+ LongPress: {
66
+ CommandName: "SeleniumSendKeysCommand",
67
+ DisplayName: "\u6A21\u62DF\u6309\u952E"
68
+ },
69
+ Swipe: {
70
+ CommandName: "SeleniumClickCommand",
71
+ DisplayName: "\u5143\u7D20\u70B9\u51FB"
72
+ }
73
+ };
74
+ export { CONTAINER_MINI_HEIGHT, CONTAINER_MINI_WIDTH, DEFAULT_WAIT_FOR_NAVIGATION_TIMEOUT, DEFAULT_WAIT_FOR_NETWORK_IDLE_CONCURRENCY, DEFAULT_WAIT_FOR_NETWORK_IDLE_TIME, DEFAULT_WAIT_FOR_NETWORK_IDLE_TIMEOUT, DEFAULT_WDA_PORT, constants_NodeType as NodeType, PLAYGROUND_SERVER_PORT, PLAYWRIGHT_EXAMPLE_CODE, SCRCPY_SERVER_PORT, TEXT_MAX_SIZE, TEXT_SIZE_THRESHOLD, WEBDRIVER_ELEMENT_ID_KEY, YAML_EXAMPLE_CODE, commandMap };
@@ -0,0 +1,6 @@
1
+ import { BASIC_ENV_KEYS } from "./types.mjs";
2
+ const getBasicEnvValue = (key)=>{
3
+ if (!BASIC_ENV_KEYS.includes(key)) throw new Error(`getBasicEnvValue with key ${key} is not supported.`);
4
+ return process.env[key];
5
+ };
6
+ export { getBasicEnvValue };
@@ -0,0 +1,97 @@
1
+ import { ANTHROPIC_API_KEY, AZURE_OPENAI_API_VERSION, AZURE_OPENAI_DEPLOYMENT, AZURE_OPENAI_ENDPOINT, AZURE_OPENAI_KEY, OPENAI_API_KEY, OPENAI_BASE_URL, OPENAI_USE_AZURE, RPASCENE_ANTHROPIC_API_KEY, RPASCENE_AZURE_OPENAI_API_VERSION, RPASCENE_AZURE_OPENAI_DEPLOYMENT, RPASCENE_AZURE_OPENAI_ENDPOINT, RPASCENE_AZURE_OPENAI_INIT_CONFIG_JSON, RPASCENE_AZURE_OPENAI_KEY, RPASCENE_AZURE_OPENAI_SCOPE, RPASCENE_GROUNDING_ANTHROPIC_API_KEY, RPASCENE_GROUNDING_AZURE_OPENAI_API_VERSION, RPASCENE_GROUNDING_AZURE_OPENAI_DEPLOYMENT, RPASCENE_GROUNDING_AZURE_OPENAI_ENDPOINT, RPASCENE_GROUNDING_AZURE_OPENAI_INIT_CONFIG_JSON, RPASCENE_GROUNDING_AZURE_OPENAI_KEY, RPASCENE_GROUNDING_AZURE_OPENAI_SCOPE, RPASCENE_GROUNDING_MODEL_NAME, RPASCENE_GROUNDING_OPENAI_API_KEY, RPASCENE_GROUNDING_OPENAI_BASE_URL, RPASCENE_GROUNDING_OPENAI_HTTP_PROXY, RPASCENE_GROUNDING_OPENAI_INIT_CONFIG_JSON, RPASCENE_GROUNDING_OPENAI_SOCKS_PROXY, RPASCENE_GROUNDING_OPENAI_USE_AZURE, RPASCENE_GROUNDING_USE_ANTHROPIC_SDK, RPASCENE_GROUNDING_USE_AZURE_OPENAI, RPASCENE_GROUNDING_VL_MODE, RPASCENE_MODEL_NAME, RPASCENE_OPENAI_API_KEY, RPASCENE_OPENAI_BASE_URL, RPASCENE_OPENAI_HTTP_PROXY, RPASCENE_OPENAI_INIT_CONFIG_JSON, RPASCENE_OPENAI_SOCKS_PROXY, RPASCENE_OPENAI_USE_AZURE, RPASCENE_PLANNING_ANTHROPIC_API_KEY, RPASCENE_PLANNING_AZURE_OPENAI_API_VERSION, RPASCENE_PLANNING_AZURE_OPENAI_DEPLOYMENT, RPASCENE_PLANNING_AZURE_OPENAI_ENDPOINT, RPASCENE_PLANNING_AZURE_OPENAI_INIT_CONFIG_JSON, RPASCENE_PLANNING_AZURE_OPENAI_KEY, RPASCENE_PLANNING_AZURE_OPENAI_SCOPE, RPASCENE_PLANNING_MODEL_NAME, RPASCENE_PLANNING_OPENAI_API_KEY, RPASCENE_PLANNING_OPENAI_BASE_URL, RPASCENE_PLANNING_OPENAI_HTTP_PROXY, RPASCENE_PLANNING_OPENAI_INIT_CONFIG_JSON, RPASCENE_PLANNING_OPENAI_SOCKS_PROXY, RPASCENE_PLANNING_OPENAI_USE_AZURE, RPASCENE_PLANNING_USE_ANTHROPIC_SDK, RPASCENE_PLANNING_USE_AZURE_OPENAI, RPASCENE_PLANNING_VL_MODE, RPASCENE_USE_ANTHROPIC_SDK, RPASCENE_USE_AZURE_OPENAI, RPASCENE_VL_MODE, RPASCENE_VQA_ANTHROPIC_API_KEY, RPASCENE_VQA_AZURE_OPENAI_API_VERSION, RPASCENE_VQA_AZURE_OPENAI_DEPLOYMENT, RPASCENE_VQA_AZURE_OPENAI_ENDPOINT, RPASCENE_VQA_AZURE_OPENAI_INIT_CONFIG_JSON, RPASCENE_VQA_AZURE_OPENAI_KEY, RPASCENE_VQA_AZURE_OPENAI_SCOPE, RPASCENE_VQA_MODEL_NAME, RPASCENE_VQA_OPENAI_API_KEY, RPASCENE_VQA_OPENAI_BASE_URL, RPASCENE_VQA_OPENAI_HTTP_PROXY, RPASCENE_VQA_OPENAI_INIT_CONFIG_JSON, RPASCENE_VQA_OPENAI_SOCKS_PROXY, RPASCENE_VQA_OPENAI_USE_AZURE, RPASCENE_VQA_USE_ANTHROPIC_SDK, RPASCENE_VQA_USE_AZURE_OPENAI, RPASCENE_VQA_VL_MODE } from "./types.mjs";
2
+ const VQA_MODEL_CONFIG_KEYS = {
3
+ modelName: RPASCENE_VQA_MODEL_NAME,
4
+ socksProxy: RPASCENE_VQA_OPENAI_SOCKS_PROXY,
5
+ httpProxy: RPASCENE_VQA_OPENAI_HTTP_PROXY,
6
+ openaiBaseURL: RPASCENE_VQA_OPENAI_BASE_URL,
7
+ openaiApiKey: RPASCENE_VQA_OPENAI_API_KEY,
8
+ openaiExtraConfig: RPASCENE_VQA_OPENAI_INIT_CONFIG_JSON,
9
+ openaiUseAzureDeprecated: RPASCENE_VQA_OPENAI_USE_AZURE,
10
+ useAzureOpenai: RPASCENE_VQA_USE_AZURE_OPENAI,
11
+ azureOpenaiScope: RPASCENE_VQA_AZURE_OPENAI_SCOPE,
12
+ azureOpenaiKey: RPASCENE_VQA_AZURE_OPENAI_KEY,
13
+ azureOpenaiEndpoint: RPASCENE_VQA_AZURE_OPENAI_ENDPOINT,
14
+ azureOpenaiApiVersion: RPASCENE_VQA_AZURE_OPENAI_API_VERSION,
15
+ azureOpenaiDeployment: RPASCENE_VQA_AZURE_OPENAI_DEPLOYMENT,
16
+ azureExtraConfig: RPASCENE_VQA_AZURE_OPENAI_INIT_CONFIG_JSON,
17
+ useAnthropicSdk: RPASCENE_VQA_USE_ANTHROPIC_SDK,
18
+ anthropicApiKey: RPASCENE_VQA_ANTHROPIC_API_KEY,
19
+ vlMode: RPASCENE_VQA_VL_MODE
20
+ };
21
+ const GROUNDING_MODEL_CONFIG_KEYS = {
22
+ modelName: RPASCENE_GROUNDING_MODEL_NAME,
23
+ socksProxy: RPASCENE_GROUNDING_OPENAI_SOCKS_PROXY,
24
+ httpProxy: RPASCENE_GROUNDING_OPENAI_HTTP_PROXY,
25
+ openaiBaseURL: RPASCENE_GROUNDING_OPENAI_BASE_URL,
26
+ openaiApiKey: RPASCENE_GROUNDING_OPENAI_API_KEY,
27
+ openaiExtraConfig: RPASCENE_GROUNDING_OPENAI_INIT_CONFIG_JSON,
28
+ openaiUseAzureDeprecated: RPASCENE_GROUNDING_OPENAI_USE_AZURE,
29
+ useAzureOpenai: RPASCENE_GROUNDING_USE_AZURE_OPENAI,
30
+ azureOpenaiScope: RPASCENE_GROUNDING_AZURE_OPENAI_SCOPE,
31
+ azureOpenaiKey: RPASCENE_GROUNDING_AZURE_OPENAI_KEY,
32
+ azureOpenaiEndpoint: RPASCENE_GROUNDING_AZURE_OPENAI_ENDPOINT,
33
+ azureOpenaiApiVersion: RPASCENE_GROUNDING_AZURE_OPENAI_API_VERSION,
34
+ azureOpenaiDeployment: RPASCENE_GROUNDING_AZURE_OPENAI_DEPLOYMENT,
35
+ azureExtraConfig: RPASCENE_GROUNDING_AZURE_OPENAI_INIT_CONFIG_JSON,
36
+ useAnthropicSdk: RPASCENE_GROUNDING_USE_ANTHROPIC_SDK,
37
+ anthropicApiKey: RPASCENE_GROUNDING_ANTHROPIC_API_KEY,
38
+ vlMode: RPASCENE_GROUNDING_VL_MODE
39
+ };
40
+ const PLANNING_MODEL_CONFIG_KEYS = {
41
+ modelName: RPASCENE_PLANNING_MODEL_NAME,
42
+ socksProxy: RPASCENE_PLANNING_OPENAI_SOCKS_PROXY,
43
+ httpProxy: RPASCENE_PLANNING_OPENAI_HTTP_PROXY,
44
+ openaiBaseURL: RPASCENE_PLANNING_OPENAI_BASE_URL,
45
+ openaiApiKey: RPASCENE_PLANNING_OPENAI_API_KEY,
46
+ openaiExtraConfig: RPASCENE_PLANNING_OPENAI_INIT_CONFIG_JSON,
47
+ openaiUseAzureDeprecated: RPASCENE_PLANNING_OPENAI_USE_AZURE,
48
+ useAzureOpenai: RPASCENE_PLANNING_USE_AZURE_OPENAI,
49
+ azureOpenaiScope: RPASCENE_PLANNING_AZURE_OPENAI_SCOPE,
50
+ azureOpenaiKey: RPASCENE_PLANNING_AZURE_OPENAI_KEY,
51
+ azureOpenaiEndpoint: RPASCENE_PLANNING_AZURE_OPENAI_ENDPOINT,
52
+ azureOpenaiApiVersion: RPASCENE_PLANNING_AZURE_OPENAI_API_VERSION,
53
+ azureOpenaiDeployment: RPASCENE_PLANNING_AZURE_OPENAI_DEPLOYMENT,
54
+ azureExtraConfig: RPASCENE_PLANNING_AZURE_OPENAI_INIT_CONFIG_JSON,
55
+ useAnthropicSdk: RPASCENE_PLANNING_USE_ANTHROPIC_SDK,
56
+ anthropicApiKey: RPASCENE_PLANNING_ANTHROPIC_API_KEY,
57
+ vlMode: RPASCENE_PLANNING_VL_MODE
58
+ };
59
+ const DEFAULT_MODEL_CONFIG_KEYS = {
60
+ modelName: RPASCENE_MODEL_NAME,
61
+ socksProxy: RPASCENE_OPENAI_SOCKS_PROXY,
62
+ httpProxy: RPASCENE_OPENAI_HTTP_PROXY,
63
+ openaiBaseURL: RPASCENE_OPENAI_BASE_URL,
64
+ openaiApiKey: RPASCENE_OPENAI_API_KEY,
65
+ openaiExtraConfig: RPASCENE_OPENAI_INIT_CONFIG_JSON,
66
+ openaiUseAzureDeprecated: RPASCENE_OPENAI_USE_AZURE,
67
+ useAzureOpenai: RPASCENE_USE_AZURE_OPENAI,
68
+ azureOpenaiScope: RPASCENE_AZURE_OPENAI_SCOPE,
69
+ azureOpenaiKey: RPASCENE_AZURE_OPENAI_KEY,
70
+ azureOpenaiEndpoint: RPASCENE_AZURE_OPENAI_ENDPOINT,
71
+ azureOpenaiApiVersion: RPASCENE_AZURE_OPENAI_API_VERSION,
72
+ azureOpenaiDeployment: RPASCENE_AZURE_OPENAI_DEPLOYMENT,
73
+ azureExtraConfig: RPASCENE_AZURE_OPENAI_INIT_CONFIG_JSON,
74
+ useAnthropicSdk: RPASCENE_USE_ANTHROPIC_SDK,
75
+ anthropicApiKey: RPASCENE_ANTHROPIC_API_KEY,
76
+ vlMode: RPASCENE_VL_MODE
77
+ };
78
+ const DEFAULT_MODEL_CONFIG_KEYS_LEGACY = {
79
+ modelName: RPASCENE_MODEL_NAME,
80
+ socksProxy: RPASCENE_OPENAI_SOCKS_PROXY,
81
+ httpProxy: RPASCENE_OPENAI_HTTP_PROXY,
82
+ openaiBaseURL: OPENAI_BASE_URL,
83
+ openaiApiKey: OPENAI_API_KEY,
84
+ openaiExtraConfig: RPASCENE_OPENAI_INIT_CONFIG_JSON,
85
+ openaiUseAzureDeprecated: OPENAI_USE_AZURE,
86
+ useAzureOpenai: RPASCENE_USE_AZURE_OPENAI,
87
+ azureOpenaiScope: RPASCENE_AZURE_OPENAI_SCOPE,
88
+ azureOpenaiKey: AZURE_OPENAI_KEY,
89
+ azureOpenaiEndpoint: AZURE_OPENAI_ENDPOINT,
90
+ azureOpenaiApiVersion: AZURE_OPENAI_API_VERSION,
91
+ azureOpenaiDeployment: AZURE_OPENAI_DEPLOYMENT,
92
+ azureExtraConfig: RPASCENE_AZURE_OPENAI_INIT_CONFIG_JSON,
93
+ useAnthropicSdk: RPASCENE_USE_ANTHROPIC_SDK,
94
+ anthropicApiKey: ANTHROPIC_API_KEY,
95
+ vlMode: 'DEFAULT_MODEL_CONFIG_KEYS has no vlMode key'
96
+ };
97
+ export { DEFAULT_MODEL_CONFIG_KEYS, DEFAULT_MODEL_CONFIG_KEYS_LEGACY, GROUNDING_MODEL_CONFIG_KEYS, PLANNING_MODEL_CONFIG_KEYS, VQA_MODEL_CONFIG_KEYS };