@withgateway/sdk 0.3.1 → 0.4.0
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.
- package/README.md +8 -6
- package/dist/cli.js +4372 -2265
- package/dist/cli.js.map +1 -1
- package/dist/cli.mjs +4362 -2256
- package/dist/cli.mjs.map +1 -1
- package/dist/files/index.d.mts +1 -1
- package/dist/files/index.d.ts +1 -1
- package/dist/files/index.js +259 -58
- package/dist/files/index.js.map +1 -1
- package/dist/files/index.mjs +249 -50
- package/dist/files/index.mjs.map +1 -1
- package/dist/hooks/index.d.mts +1 -1
- package/dist/hooks/index.d.ts +1 -1
- package/dist/hooks/index.js +124 -11
- package/dist/hooks/index.js.map +1 -1
- package/dist/hooks/index.mjs +124 -11
- package/dist/hooks/index.mjs.map +1 -1
- package/dist/{index-C3UzD0G3.d.mts → index-CDPQBsU5.d.mts} +19 -3
- package/dist/{index-C3UzD0G3.d.ts → index-CDPQBsU5.d.ts} +19 -3
- package/dist/{index-CBqbB_0J.d.ts → index-DUHmS74p.d.ts} +1 -1
- package/dist/{index-D-AMnAMa.d.mts → index-mJhG3vZU.d.mts} +1 -1
- package/dist/index.d.mts +5 -5
- package/dist/index.d.ts +5 -5
- package/dist/index.js +2240 -789
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +2150 -739
- package/dist/index.mjs.map +1 -1
- package/dist/{media-CbcAfQvd.d.mts → media-BIApiPzS.d.mts} +21 -2
- package/dist/{media-CbcAfQvd.d.ts → media-BIApiPzS.d.ts} +21 -2
- package/dist/traces/index.d.mts +1 -1
- package/dist/traces/index.d.ts +1 -1
- package/dist/traces/index.js +253 -52
- package/dist/traces/index.js.map +1 -1
- package/dist/traces/index.mjs +243 -44
- package/dist/traces/index.mjs.map +1 -1
- package/dist/tracing/index.d.mts +2 -2
- package/dist/tracing/index.d.ts +2 -2
- package/dist/tracing/index.js +75 -13
- package/dist/tracing/index.js.map +1 -1
- package/dist/tracing/index.mjs +75 -13
- package/dist/tracing/index.mjs.map +1 -1
- package/dist/worlds/index.d.mts +893 -482
- package/dist/worlds/index.d.ts +893 -482
- package/dist/worlds/index.js +1968 -669
- package/dist/worlds/index.js.map +1 -1
- package/dist/worlds/index.mjs +1960 -662
- package/dist/worlds/index.mjs.map +1 -1
- package/package.json +1 -1
- package/runtime/gatewaysdk/environment/_bundle.py +2 -27
- package/runtime/gatewaysdk/environment/_materialize.py +48 -88
- package/runtime/gatewaysdk/environment/_world.py +155 -237
- package/runtime/gatewaysdk/environment/backing.py +133 -0
- package/runtime/gatewaysdk/environment/core.py +2 -17
- package/runtime/gatewaysdk/environment/legacy_sqlite.py +288 -0
- package/runtime/gatewaysdk/environment/reward_keys.py +25 -0
- package/runtime/gatewaysdk/environment/runtime.py +8 -13
- package/runtime/gatewaysdk/environment/schema/__init__.py +4 -4
- package/runtime/gatewaysdk/environment/schema/admin_routes.py +86 -0
- package/runtime/gatewaysdk/environment/schema/admission.py +174 -0
- package/runtime/gatewaysdk/environment/schema/api.py +347 -892
- package/runtime/gatewaysdk/environment/schema/assertions.py +458 -0
- package/runtime/gatewaysdk/environment/schema/batch.py +44 -39
- package/runtime/gatewaysdk/environment/schema/bundle_runtime.py +17 -5
- package/runtime/gatewaysdk/environment/schema/cache_layout.py +5 -0
- package/runtime/gatewaysdk/environment/schema/call_capture.py +309 -0
- package/runtime/gatewaysdk/environment/schema/call_log.py +503 -0
- package/runtime/gatewaysdk/environment/schema/call_redaction.py +526 -0
- package/runtime/gatewaysdk/environment/schema/cast.py +15 -35
- package/runtime/gatewaysdk/environment/schema/compiler.py +334 -158
- package/runtime/gatewaysdk/environment/schema/conform.py +14 -39
- package/runtime/gatewaysdk/environment/schema/connector.py +113 -211
- package/runtime/gatewaysdk/environment/schema/connectors/confluence/connector.toml +1 -12
- package/runtime/gatewaysdk/environment/schema/connectors/github/connector.toml +1 -0
- package/runtime/gatewaysdk/environment/schema/connectors/servicenow/connector.toml +2 -5
- package/runtime/gatewaysdk/environment/schema/cors.py +54 -0
- package/runtime/gatewaysdk/environment/schema/credentials.py +313 -8
- package/runtime/gatewaysdk/environment/schema/data.py +60 -216
- package/runtime/gatewaysdk/environment/schema/database/__init__.py +24 -0
- package/runtime/gatewaysdk/environment/schema/database/audit.py +121 -0
- package/runtime/gatewaysdk/environment/schema/database/base.py +936 -0
- package/runtime/gatewaysdk/environment/schema/database/budget.py +33 -0
- package/runtime/gatewaysdk/environment/schema/database/connections.py +101 -0
- package/runtime/gatewaysdk/environment/schema/database/engines.py +8 -0
- package/runtime/gatewaysdk/environment/schema/database/guard.py +215 -0
- package/runtime/gatewaysdk/environment/schema/database/ingest.py +154 -0
- package/runtime/gatewaysdk/environment/schema/database/matching.py +58 -0
- package/runtime/gatewaysdk/environment/schema/database/provenance.py +30 -0
- package/runtime/gatewaysdk/environment/schema/database/reads.py +169 -0
- package/runtime/gatewaysdk/environment/schema/database/rows.py +53 -0
- package/runtime/gatewaysdk/environment/schema/database/runtime_rows.py +39 -0
- package/runtime/gatewaysdk/environment/schema/database/sqlite.py +393 -0
- package/runtime/gatewaysdk/environment/schema/declared_routes.py +210 -0
- package/runtime/gatewaysdk/environment/schema/domain_migration.py +236 -0
- package/runtime/gatewaysdk/environment/schema/door.py +899 -0
- package/runtime/gatewaysdk/environment/schema/envelope.py +227 -0
- package/runtime/gatewaysdk/environment/schema/extract.py +6 -13
- package/runtime/gatewaysdk/environment/schema/grading.py +90 -103
- package/runtime/gatewaysdk/environment/schema/handler_errors.py +163 -12
- package/runtime/gatewaysdk/environment/schema/host.py +237 -1795
- package/runtime/gatewaysdk/environment/schema/host_control.py +144 -0
- package/runtime/gatewaysdk/environment/schema/host_handoff.py +370 -0
- package/runtime/gatewaysdk/environment/schema/host_loops.py +97 -0
- package/runtime/gatewaysdk/environment/schema/host_owners.py +121 -0
- package/runtime/gatewaysdk/environment/schema/host_proxy.py +111 -0
- package/runtime/gatewaysdk/environment/schema/host_requests.py +6 -0
- package/runtime/gatewaysdk/environment/schema/host_session.py +126 -0
- package/runtime/gatewaysdk/environment/schema/host_surfaces.py +79 -21
- package/runtime/gatewaysdk/environment/schema/host_transfers.py +127 -0
- package/runtime/gatewaysdk/environment/schema/host_versions.py +242 -0
- package/runtime/gatewaysdk/environment/schema/host_workers.py +577 -0
- package/runtime/gatewaysdk/environment/schema/journal.py +437 -0
- package/runtime/gatewaysdk/environment/schema/lanes.py +53 -0
- package/runtime/gatewaysdk/environment/schema/ledger_spill.py +828 -0
- package/runtime/gatewaysdk/environment/schema/local.py +58 -170
- package/runtime/gatewaysdk/environment/schema/mapping.py +5 -25
- package/runtime/gatewaysdk/environment/schema/openapi_import.py +112 -73
- package/runtime/gatewaysdk/environment/schema/openapi_paging.py +147 -0
- package/runtime/gatewaysdk/environment/schema/openapi_payloads.py +288 -0
- package/runtime/gatewaysdk/environment/schema/openapi_routes.py +97 -102
- package/runtime/gatewaysdk/environment/schema/openapi_schemas.py +113 -30
- package/runtime/gatewaysdk/environment/schema/platform.py +137 -187
- package/runtime/gatewaysdk/environment/schema/platform_import.py +2 -3
- package/runtime/gatewaysdk/environment/schema/platform_query.py +61 -5
- package/runtime/gatewaysdk/environment/schema/primary_key.py +61 -0
- package/runtime/gatewaysdk/environment/schema/proof.py +19 -12
- package/runtime/gatewaysdk/environment/schema/request_body.py +238 -0
- package/runtime/gatewaysdk/environment/schema/request_ledger.py +958 -0
- package/runtime/gatewaysdk/environment/schema/route_bindings.py +25 -3
- package/runtime/gatewaysdk/environment/schema/route_miss.py +54 -0
- package/runtime/gatewaysdk/environment/schema/runtime.py +178 -308
- package/runtime/gatewaysdk/environment/schema/served_names.py +58 -0
- package/runtime/gatewaysdk/environment/schema/session_files.py +275 -0
- package/runtime/gatewaysdk/environment/schema/session_move.py +275 -0
- package/runtime/gatewaysdk/environment/schema/skills/agents/connector-template-author.md +5 -1
- package/runtime/gatewaysdk/environment/schema/skills/benchmarks-getting-started/SKILL.md +10 -11
- package/runtime/gatewaysdk/environment/schema/skills/connector-schema-authoring/SKILL.md +49 -16
- package/runtime/gatewaysdk/environment/schema/skills/world-data-ingestion/ROWS.md +39 -9
- package/runtime/gatewaysdk/environment/schema/skills/world-data-ingestion/SKILL.md +27 -27
- package/runtime/gatewaysdk/environment/schema/skills/worlds-getting-started/SKILL.md +33 -33
- package/runtime/gatewaysdk/environment/schema/skills/worlds-getting-started/references/cli-mcp-map.md +13 -7
- package/runtime/gatewaysdk/environment/schema/skills/worlds-getting-started/references/gotchas.md +49 -1
- package/runtime/gatewaysdk/environment/schema/skills/worlds-getting-started/references/journal-checks.md +182 -0
- package/runtime/gatewaysdk/environment/schema/skills/worlds-getting-started/references/openapi-import.md +50 -21
- package/runtime/gatewaysdk/environment/schema/slack.py +4 -8
- package/runtime/gatewaysdk/environment/schema/snapshot.py +516 -140
- package/runtime/gatewaysdk/environment/schema/spill_files.py +228 -0
- package/runtime/gatewaysdk/environment/schema/store_contract.py +8 -14
- package/runtime/gatewaysdk/environment/schema/tasks.py +267 -276
- package/runtime/gatewaysdk/environment/schema/tools_world.py +146 -242
- package/runtime/gatewaysdk/environment/schema/ui.py +24 -5
- package/runtime/gatewaysdk/environment/schema/ui_static/app.js +100 -130
- package/runtime/gatewaysdk/environment/schema/ui_static/index.html +1 -8
- package/runtime/gatewaysdk/environment/schema/validation.py +235 -41
- package/runtime/gatewaysdk/environment/schema/verbs.py +32 -36
- package/runtime/gatewaysdk/environment/schema/worker.py +6 -4
- package/runtime/gatewaysdk/environment/schema/workers.py +345 -96
- package/runtime/gatewaysdk/environment/schema/world_host.py +953 -0
- package/runtime/gatewaysdk/environment/schema/world_sql.py +81 -0
- package/runtime/gatewaysdk/environment/schema/world_tests.py +80 -50
- package/runtime/gatewaysdk/environment/score.py +57 -0
- package/runtime/gatewaysdk/environment/secret_values.py +36 -0
- package/runtime/gatewaysdk/environment/world.py +43 -4
- package/runtime/gatewaysdk/environment/world_session_contract.py +46 -5
- package/skills/agents/connector-template-author.md +5 -1
- package/skills/benchmarks-getting-started/SKILL.md +10 -11
- package/skills/connector-schema-authoring/SKILL.md +49 -16
- package/skills/connector-schema-authoring/connector-worlds.md +142 -11
- package/skills/connector-schema-authoring/world-schema.md +103 -51
- package/skills/world-data-ingestion/ROWS.md +39 -9
- package/skills/world-data-ingestion/SKILL.md +27 -27
- package/skills/worlds-getting-started/SKILL.md +33 -33
- package/skills/worlds-getting-started/references/cli-mcp-map.md +13 -7
- package/skills/worlds-getting-started/references/gotchas.md +49 -1
- package/skills/worlds-getting-started/references/journal-checks.md +182 -0
- package/skills/worlds-getting-started/references/openapi-import.md +50 -21
- package/runtime/gatewaysdk/environment/schema/store.py +0 -1013
|
@@ -26,6 +26,12 @@ gateway worlds schema init ./x --from-openapi github.json --include '/repos/{own
|
|
|
26
26
|
Inside a world sandbox (`run_gateway_cli`, `sandbox exec`) only a workspace path is accepted:
|
|
27
27
|
write the document into the workspace first (`sandbox write --from spec.yaml`), then import.
|
|
28
28
|
|
|
29
|
+
The import itself runs in this machine's schema runtime whenever it has one; `GATEWAY_RUNTIME=local`
|
|
30
|
+
demands it and sends nothing to the platform. A YAML document is read by PyYAML in the Python that
|
|
31
|
+
runs the runtime: without it the command stops before anything is sent and names the fix
|
|
32
|
+
(`pip install pyyaml` there, point `GATEWAY_PYTHON` at a Python that has it, or convert the
|
|
33
|
+
document to JSON).
|
|
34
|
+
|
|
29
35
|
## What the plan says
|
|
30
36
|
|
|
31
37
|
`--from-openapi` always prints the plan first (JSON, one object):
|
|
@@ -50,28 +56,51 @@ With `--plan-only` the same object carries `"written": false` and no `domain`/`n
|
|
|
50
56
|
|
|
51
57
|
## Conversion rules (decided; the importer documents them in `schema/provenance.json`)
|
|
52
58
|
|
|
53
|
-
- **Entities
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
`
|
|
57
|
-
a
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
59
|
+
- **Entities are the rows the routes carry.** The importer reads each selected operation's
|
|
60
|
+
response and request body through the vendor's envelope to the item schema: an array of
|
|
61
|
+
objects, or an object that declares no key and holds exactly one array (Crossref's
|
|
62
|
+
`{status, message: {items: [Work], total-results}}`, ClinicalTrials.gov's
|
|
63
|
+
`{studies: [Study], nextPageToken}`); a single-row response is the item when some list carries
|
|
64
|
+
it, it declares a key, or it names the field the route's own `{segment}` reads it by, else the
|
|
65
|
+
one object its wrapper holds. Wrappers never become entities. An item no planned route reads or
|
|
66
|
+
writes is no entity either (it stays an inline `$def`). Each entity is a `$defs` entry plus
|
|
67
|
+
`x-gateway.entities.<snake_plural>` with `primary_key` (snake_case, at most 64 characters, the
|
|
68
|
+
original kept in provenance); `allOf` is merged; `oneOf`/`anyOf` become a union the world
|
|
69
|
+
validator accepts. Entity roots close (`additionalProperties: false`); the vendor's field names
|
|
70
|
+
are kept exactly as spelled, hyphens included (`reference-count`), so a rows file shaped like
|
|
71
|
+
the vendor's response imports as it is.
|
|
72
|
+
- **Keys.** A declared key first (`id`, `<name>Id`, `<name>_id`, a `readOnly` field the vendor
|
|
73
|
+
marks `x-unique`/`x-primary-key`), else the field the single-row route reads the row by:
|
|
74
|
+
top-level and spelled the vendor's way (`/works/{doi}` → `DOI`), or nested in the row's
|
|
75
|
+
objects (`/studies/{nctId}` → the JSON Pointer `/protocolSection/identificationModule/nctId`,
|
|
76
|
+
every object on the path made required; never through an array or a nullable object). An item
|
|
77
|
+
only list routes carry falls back to its first required string/integer field, with a warning
|
|
78
|
+
that rows sharing it collapse: mark the key with `x-primary-key` or include the read route.
|
|
63
79
|
- **Routes.** Every path+method in `get|post|put|patch|delete` becomes an `[[operations]]` entry:
|
|
64
80
|
`name` = `operationId` snake_cased, at most 64 characters, deduped with `_2`, `_3` and a
|
|
65
|
-
warning; `entity` = the
|
|
66
|
-
|
|
67
|
-
parameters become `params
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
81
|
+
warning; `entity` = the entity its response (or, for a write, its body or the path's `GET`)
|
|
82
|
+
carries, a list route or `read|create|update|delete` by method; path parameters and declared
|
|
83
|
+
query parameters become `params`, the vendor's names kept, dots included (`query.bibliographic`,
|
|
84
|
+
`filter.overallStatus`). The envelope's path becomes `results` and the route's dotted
|
|
85
|
+
`envelope` (`message.items`), and the rest of the envelope its `wrapper`, so the served world
|
|
86
|
+
answers the vendor's shape (`{status: "ok", message-type: "work-list", message: {items, …}}`).
|
|
87
|
+
On a list route a declared query parameter that names an entity field becomes a `filter`
|
|
88
|
+
(paging names never do). A single read whose path argument names no field of the row, and an
|
|
89
|
+
operation whose response is not an entity (login, upload, HTML), stay **passthrough** routes with
|
|
90
|
+
no entity, the reason in the plan — served, answering `501 {"error": "not_modelled"}` until you
|
|
91
|
+
give them a handler.
|
|
92
|
+
- **Paging.** A cursor parameter (`cursor`, `pageToken`) with a next-cursor field beside the rows
|
|
93
|
+
(`next-cursor`, `nextPageToken`) pages by cursor; an `offset` parameter by offset; the limit's
|
|
94
|
+
`default` becomes `page_size`; the count beside the rows (`total-results`, `totalCount`) is the
|
|
95
|
+
hits key. `[api]` pages the way most list routes do, a route paging otherwise names its own
|
|
96
|
+
`page`, and page-number paging (`page` + `per_page`) is named in a warning (that route answers
|
|
97
|
+
every row on one page).
|
|
98
|
+
- **Tools.** An import declares none: routes are never tools. An agent reaches the world's routes
|
|
99
|
+
over HTTP (the api url and token `session open --surface api` prints); declare a tool in
|
|
100
|
+
`x-gateway.tools`, with a handler, where an agent needs one.
|
|
73
101
|
- **Skipped, with a reason:** `HEAD`/`OPTIONS`/`TRACE`; a path argument that is not an
|
|
74
|
-
identifier; a
|
|
102
|
+
identifier; a path that repeats a placeholder (`/a/{id}/{id}`); a second operation on the same
|
|
103
|
+
method+path shape. **Refused, with a JSON pointer
|
|
75
104
|
into the document, nothing written:** no `paths`; an unknown or external `$ref`; an entity root
|
|
76
105
|
that is (transitively) cyclic — model the recursion as a relationship field (`parent_id`)
|
|
77
106
|
instead; a path parameter nothing declares (`--param <name>` on a hand-written route); a
|
|
@@ -85,6 +114,6 @@ With `--plan-only` the same object carries `"written": false` and no `domain`/`n
|
|
|
85
114
|
|
|
86
115
|
The printed `next` steps are the loop, in order: `schema compile`, `schema check`, `data import
|
|
87
116
|
<rows.json> --entity <first list entity>` (rows shaped like the vendor's response), `worlds serve`
|
|
88
|
-
then `
|
|
89
|
-
tree lives in a sandbox. `connector conform ./x --openapi <the same document>` then checks the
|
|
117
|
+
then `curl -s http://127.0.0.1:<port>/<list path>` (the route over HTTP), and `sandbox commit` when
|
|
118
|
+
the tree lives in a sandbox. `connector conform ./x --openapi <the same document>` then checks the
|
|
90
119
|
served world back against the spec.
|