@maxceem/agw 0.1.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/LICENSE +202 -0
- package/README.md +63 -0
- package/dist/agw.mjs +18815 -0
- package/dist/release/0.1.0/console/.assetsignore +1 -0
- package/dist/release/0.1.0/console/assets/endpoints-zOm2MGG0.js +12 -0
- package/dist/release/0.1.0/console/assets/index-CZYi3Ga7.js +98 -0
- package/dist/release/0.1.0/console/assets/index-CsWBdB28.css +2 -0
- package/dist/release/0.1.0/console/assets/module-DY58MOwM.js +2 -0
- package/dist/release/0.1.0/console/assets/usage-x48kOqlj.js +42 -0
- package/dist/release/0.1.0/console/favicon.svg +22 -0
- package/dist/release/0.1.0/console/index.html +34 -0
- package/dist/release/0.1.0/manifest.json +23 -0
- package/dist/release/0.1.0/migrations/0000_initial.sql +315 -0
- package/dist/release/0.1.0/worker/index.js +86772 -0
- package/dist/release/0.1.0/wrangler.json +82 -0
- package/dist/release-integrity.json +1 -0
- package/package.json +36 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2026 Maksym Mykhailenko
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# App AI Gateway CLI
|
|
2
|
+
|
|
3
|
+
The `@maxceem/agw` package provides the `agw` executable. Node.js 22.19 or newer is required. It includes the compatible gateway release and Wrangler toolchain; end users do not need Git, pnpm, a global Wrangler installation, or a repository checkout.
|
|
4
|
+
|
|
5
|
+
```sh
|
|
6
|
+
npx @maxceem/agw provider add --type openai
|
|
7
|
+
npx @maxceem/agw app add --type ios --team-id ABCDE12345 --bundle-id com.example.app
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
A fresh cloud connection creates your account only when adding a provider, provider gateway, or application. Help, lists, status, validation and dry runs never create accounts. Logout retains your selected deployment and prior account marker; invalid or revoked access requires login, with no automatic fallback or second account.
|
|
11
|
+
|
|
12
|
+
For automation, have a human supply a provider credential in their own browser:
|
|
13
|
+
|
|
14
|
+
```sh
|
|
15
|
+
agw provider add --type openai --browser --no-open --json
|
|
16
|
+
agw operation wait <operation-id> --timeout 300 --json
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Share both the returned URL and human confirmation code where present. Hidden terminal input only prevents echo; an agent controlling that terminal can still observe it. The browser must be outside the agent's observable browser surface for credential isolation. Never pass credentials as command arguments. `--key-stdin` explicitly reads a single secret line. `--no-input` prohibits terminal prompts, and `--no-open` returns a browser operation without waiting.
|
|
20
|
+
|
|
21
|
+
Run `agw --help` for the complete command surface and `agw <group> <command> --help` for its flags. Resource IDs and slugs are exact; display names are not selectors. File outputs never overwrite existing files. Server application keys are written with mode 0600 and never included in stdout. If persistence fails, the CLI attempts immediate revocation and reports the key ID for recovery.
|
|
22
|
+
|
|
23
|
+
Application JSON uses the gateway's shared complete write schema (`name`, `config`, optional `status`). Derive an editable definition from a saved app with `agw app show <app-id> --json | jq '.result.app | {name, config, status}'`; `app validate --file` and `app add --file --dry-run` validate it without account creation. Offline validation reports skipped remote checks. File mode preserves omission of App Attest environments; the simple iOS flags explicitly enable production and development. Application updates require the original ETag in `If-Match`; conflicting edits return an error instead of overwriting changes. Retained selected providers keep their detailed policies.
|
|
24
|
+
|
|
25
|
+
Swift snippets use the current package at `https://github.com/maxceem/app-ai-gateway-swift` (from version 1.0.0), actual application/provider IDs, and the saved authentication mode. Issuer examples require replacing the indicated identity SDK call. Requests still need a provider-native body and must be sent by the caller. No setup or readiness check sends paid inference or proves physical-device attestation.
|
|
26
|
+
|
|
27
|
+
## Output and state
|
|
28
|
+
|
|
29
|
+
`--json` emits exactly one JSON document to stdout. Progress goes to stderr. The result envelope is `{schemaVersion:1,ok:true,context:{url,accountId?,deploymentId?},result}`. Errors are `{schemaVersion:1,ok:false,error:{code,message,nextAction,details?}}`. Unknown remote fields are excluded from output; complete validated application config preserves provider-native endpoint parameters.
|
|
30
|
+
|
|
31
|
+
Exit statuses: `0` success (including pending handoff initiation), `2` input/validation error, `3` remote/connectivity or failed handoff, `4` local state/recovery/authentication issue, `5` wait timeout. Timeout includes still-pending operation metadata and does not cancel or extend the server operation. Poll authorization is stored separately from public operation IDs/URLs. Authentication handoff completion is persisted before output, and replay cannot undo a logout or later connection switch.
|
|
32
|
+
|
|
33
|
+
State is `$XDG_STATE_HOME/agw` or `~/.local/state/agw` on Unix, and `%LOCALAPPDATA%/agw` on Windows. The directory is mode 0700 and files are mode 0600. It contains one active connection, the previous connection for intentional recovery, pending operations, creation retry proofs, application keys, and protected installation journals. No public profile selectors or gateway credential environment overrides exist. Back up this directory securely. Concurrent commands use an exclusive lock; after a crashed process, inspect the PID in `connection.lock` before removing that lock. Never delete connection state merely to resolve an authentication error.
|
|
34
|
+
|
|
35
|
+
Public API URLs require HTTPS, no userinfo, query, fragment or path. Only `localhost`, `127.0.0.1` and `[::1]` permit HTTP for local development. Authenticated HTTP redirects are refused. Connecting authenticates only to the requested origin and selects it after success.
|
|
36
|
+
|
|
37
|
+
## Self-hosting
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
agw deployment setup --name my-gateway --no-domain
|
|
41
|
+
agw deployment update --dry-run
|
|
42
|
+
agw deployment domain --hostname ai.example.com --dry-run
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Setup obtains Cloudflare authorization using bundled Wrangler OAuth, or accepts standard securely configured Cloudflare credentials such as `CLOUDFLARE_API_TOKEN`. If more than one Cloudflare account is accessible, choose one with `--cloudflare-account-id`. Noninteractive mutations require explicit configuration and `--yes`; `--yes` does not grant Cloudflare permissions or approve browser identity ceremonies.
|
|
46
|
+
|
|
47
|
+
The npm package contains a versioned Worker bundle, console assets, migrations, configuration, and SHA-256 manifest. npm package integrity authenticates the package; local manifest/file digests detect corrupt assets before deployment. `--version` selects only the bundled compatible release; use the matching CLI package version for another release. No unversioned source download or arbitrary downgrade is performed. Release format/schema versions are checked before mutation.
|
|
48
|
+
|
|
49
|
+
Installation journals are written before creating resources, keep generated vault/signing/bootstrap secrets across retries, and bind the Cloudflare account, Worker, D1 database and immutable deployment ID. A Worker name collision never authorizes takeover. Retry an incomplete setup with the same name/account; its previous active gateway connection remains selected until bootstrap succeeds. A completed setup does not replay retired bootstrap credentials or overwrite subsequently rotated secrets. Updates preserve existing secrets and reject unsupported schema transitions. Database migrations do not have an automatic rollback.
|
|
50
|
+
|
|
51
|
+
A URL-only connection can be matched interactively to an explicitly selected accessible Worker only when its Cloudflare `DEPLOYMENT_ID` matches the gateway. Unsupported extra resource bindings fail rather than being discarded. Noninteractive deployment administration needs the existing installation journal. Dry runs discover/validate only; they do not provision resources, generate/upload secrets, change DNS, bootstrap accounts or select connections.
|
|
52
|
+
|
|
53
|
+
Custom domains require an accessible active zone. Existing unrelated DNS or Worker domain attachments are refused. The new endpoint must identify the same deployment before credentials follow it. Existing hostnames remain served; mobile applications keep their embedded URL until updated. Changing from cloud to self-hosting does not migrate app IDs, provider credentials, usage or existing applications.
|
|
54
|
+
|
|
55
|
+
## Release verification for contributors
|
|
56
|
+
|
|
57
|
+
`pnpm run cli:check` type-checks the CLI with `tsgo` and then bundles the portable schemas and executable. `pnpm run cli:test` runs parser, state, transport, command and mocked deployment tests; both are included in root verification. `pnpm --filter @maxceem/agw release:build` builds the actual deployable bundle locally. `npm pack` runs that release build and packages only `dist`, this README and the Apache-2.0 license. Verify the tarball and invoke its installed executable outside the repository before publishing. Publishing and live Cloudflare operations are separate release decisions.
|
|
58
|
+
|
|
59
|
+
Creation retries persist a request proof before sending provider, gateway, app or application-key creation. Repeating an unfinished saved request returns its original result. After successful output delivery, its local pending receipt is acknowledged, so a later invocation is a new intentional creation. A server key response can be recovered remotely for 15 minutes; after that, the error identifies the existing resource so you can inspect and replace its key intentionally. Non-secret receipt records prevent duplicate creation for the lifetime of the account. An unfinished local request older than 90 days refuses to submit again automatically.
|
|
60
|
+
|
|
61
|
+
The CLI saves a one-time key response in protected local state before writing the selected `--key-output` file. If the file write fails, repeat the same command to complete that file, or choose a new unused output path; this uses the saved active key and does not mint another. Once file delivery completes, the recovery copy is removed; a retry before successful command output verifies that original file. After stdout delivery is acknowledged, a later key creation is a new request and requires a new unused output file. Existing unrelated files and replaced output reservations are never overwritten.
|
|
62
|
+
|
|
63
|
+
Unfinished bootstrap attempts also have a 90-day local retry deadline. Missing or expired timestamps fail closed and preserve the proof for recovery. Server cleanup retains only a non-secret, proof-bound bootstrap tombstone after deleting an expired account, so an old retry cannot recreate that account. The tombstone contains no account identity or credential and is intentionally retained beyond ordinary challenge expiry.
|