@homeflare/distilled-grafana 0.2.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 +201 -0
- package/README.md +85 -0
- package/dist/credentials.d.ts +42 -0
- package/dist/credentials.d.ts.map +1 -0
- package/dist/credentials.js +48 -0
- package/dist/credentials.js.map +1 -0
- package/dist/errors.d.ts +36 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +26 -0
- package/dist/errors.js.map +1 -0
- package/dist/index.d.ts +24 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +24 -0
- package/dist/index.js.map +1 -0
- package/dist/pagination.d.ts +11 -0
- package/dist/pagination.d.ts.map +1 -0
- package/dist/pagination.js +11 -0
- package/dist/pagination.js.map +1 -0
- package/dist/protocol.d.ts +18 -0
- package/dist/protocol.d.ts.map +1 -0
- package/dist/protocol.js +58 -0
- package/dist/protocol.js.map +1 -0
- package/dist/retry.d.ts +32 -0
- package/dist/retry.d.ts.map +1 -0
- package/dist/retry.js +32 -0
- package/dist/retry.js.map +1 -0
- package/dist/services/grafana.d.ts +5677 -0
- package/dist/services/grafana.d.ts.map +1 -0
- package/dist/services/grafana.js +7069 -0
- package/dist/services/grafana.js.map +1 -0
- package/dist/services/index.d.ts +2 -0
- package/dist/services/index.d.ts.map +1 -0
- package/dist/services/index.js +3 -0
- package/dist/services/index.js.map +1 -0
- package/dist/traits.d.ts +11 -0
- package/dist/traits.d.ts.map +1 -0
- package/dist/traits.js +11 -0
- package/dist/traits.js.map +1 -0
- package/package.json +81 -0
- package/src/credentials.ts +72 -0
- package/src/errors.ts +50 -0
- package/src/index.ts +33 -0
- package/src/pagination.ts +10 -0
- package/src/protocol.ts +82 -0
- package/src/retry.ts +54 -0
- package/src/services/grafana.ts +16453 -0
- package/src/services/index.ts +2 -0
- package/src/traits.ts +44 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# @homeflare/distilled-grafana
|
|
2
|
+
|
|
3
|
+
This package is **not a HomeFlare SDK**. It is an unmodified copy of
|
|
4
|
+
`@distilled.cloud/grafana`, generated by the [distilled](https://github.com/alchemy-run/distilled)
|
|
5
|
+
pipeline from Grafana's own committed OpenAPI 3.0.3 document
|
|
6
|
+
(`public/openapi3.json` at `grafana/grafana@main`, mirror commit `38c18a03`,
|
|
7
|
+
dated 2026-09-11 — see the distilled clone's `packages/grafana/README.md` for
|
|
8
|
+
the full provenance and the `v13.1.4`-tag spot-check), published here under
|
|
9
|
+
its own name only because `@distilled.cloud/grafana` does not exist on npm
|
|
10
|
+
yet — the kit builds it in a local clone of `alchemy-run/distilled` but, per
|
|
11
|
+
house policy, never pushes to that upstream. See
|
|
12
|
+
[`../alchemy/docs/distilled-interim.md`](../alchemy/docs/distilled-interim.md)
|
|
13
|
+
for the full route every distilled-sourced vendor package follows, and why
|
|
14
|
+
this one exists at all.
|
|
15
|
+
|
|
16
|
+
⛔ **Do not hand-edit anything under `src/`.** The whole point of the route
|
|
17
|
+
above is that this directory is _copied_, not written — a fix belongs in the
|
|
18
|
+
distilled clone's `packages/grafana/`, regenerated, then copied back here.
|
|
19
|
+
|
|
20
|
+
⚠️ **License.** Apache-2.0, not the kit's usual MIT — this content is a
|
|
21
|
+
redistribution of `alchemy-run/distilled`'s own Apache-2.0-licensed output,
|
|
22
|
+
and relicensing a copy would misstate what it is. See `LICENSE`.
|
|
23
|
+
|
|
24
|
+
## What's in it
|
|
25
|
+
|
|
26
|
+
One service module (`grafana`), 282 Effect-typed operations covering
|
|
27
|
+
Grafana's classic HTTP API — datasources, folders, dashboards, alerting
|
|
28
|
+
provisioning (alert rules, rule groups, contact points, notification
|
|
29
|
+
policies, mute timings, templates), orgs/users/teams/reports/snapshots/
|
|
30
|
+
public dashboards — with `catchTag`-able errors for every status the
|
|
31
|
+
operations declare, including `PreconditionFailed` (412, a dashboard
|
|
32
|
+
`version` conflict on update) and the alerting provisioning writes'
|
|
33
|
+
`X-Disable-Provenance` header input.
|
|
34
|
+
|
|
35
|
+
32 of those 282 (folders, dashboards, alerting provisioning writes) were
|
|
36
|
+
added by this package's introducing PR: Grafana's spec marks the whole
|
|
37
|
+
classic write surface `deprecated: true`, pointing at a newer
|
|
38
|
+
Kubernetes-apiserver route this spec does not describe at all — see the
|
|
39
|
+
distilled clone's `packages/grafana/scripts/convert.ts` header and
|
|
40
|
+
`patches/*.patch.json` for the fix, and
|
|
41
|
+
[`../alchemy/docs/grafana.md`](../alchemy/docs/grafana.md) for how this
|
|
42
|
+
was measured.
|
|
43
|
+
|
|
44
|
+
```ts
|
|
45
|
+
import * as Grafana from '@distilled.cloud/grafana'; // aliased onto this package — see docs/distilled-interim.md
|
|
46
|
+
import * as Effect from 'effect/Effect';
|
|
47
|
+
|
|
48
|
+
const program = Grafana.Services.grafana
|
|
49
|
+
.getFolderByUID({ folder_uid: 'my-folder' })
|
|
50
|
+
.pipe(
|
|
51
|
+
Effect.provide(
|
|
52
|
+
Grafana.fromApiKey({ apiKey: '...', apiBaseUrl: 'https://grafana.example.com' }),
|
|
53
|
+
),
|
|
54
|
+
);
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Kit code never imports `@homeflare/distilled-grafana` directly — always
|
|
58
|
+
`@distilled.cloud/grafana`, aliased in the consuming package's `package.json`
|
|
59
|
+
(`"@distilled.cloud/grafana": "npm:@homeflare/distilled-grafana@<version>"`),
|
|
60
|
+
so the eventual cutover to the real published package is a one-line alias
|
|
61
|
+
swap with no import changes anywhere in the kit.
|
|
62
|
+
|
|
63
|
+
## Updating it
|
|
64
|
+
|
|
65
|
+
From the distilled clone's `homeflare/grafana` worktree:
|
|
66
|
+
|
|
67
|
+
```sh
|
|
68
|
+
pnpm --filter @distilled.cloud/grafana run generate
|
|
69
|
+
pnpm --filter @distilled.cloud/grafana run typecheck
|
|
70
|
+
pnpm format && pnpm specs:check
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Then copy `src/` here verbatim, add a changeset (patch — the generated
|
|
74
|
+
content changed but nothing new is callable; minor — a new capability like
|
|
75
|
+
the folder/dashboard/alerting-provisioning operations this PR adds becomes
|
|
76
|
+
callable, per the kit's own new-feature-vs-swap convention), and let the
|
|
77
|
+
kit's normal release flow publish it and bump this package's own `version`.
|
|
78
|
+
|
|
79
|
+
## License
|
|
80
|
+
|
|
81
|
+
Apache-2.0 (see `LICENSE`) — not the kit's usual MIT. `src/` is an
|
|
82
|
+
unmodified copy of `@distilled.cloud/grafana`'s own output from
|
|
83
|
+
`alchemy-run/distilled`, which is itself Apache-2.0; this package's own
|
|
84
|
+
files (`package.json`, `tsconfig.json`, `scripts/smoke.ts`, this README)
|
|
85
|
+
are offered under the same terms.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Grafana credentials — hand-written.
|
|
3
|
+
*
|
|
4
|
+
* The `Credentials` service holds an *effect* that resolves the current
|
|
5
|
+
* credentials on every request (the protocol layer resolves it per request
|
|
6
|
+
* on the calling fiber).
|
|
7
|
+
*
|
|
8
|
+
* Grafana authenticates HTTP API requests with a service account token
|
|
9
|
+
* (`Authorization: Bearer <token>`). The optional `X-Grafana-Org-Id` header
|
|
10
|
+
* selects the organization the action applies to.
|
|
11
|
+
*
|
|
12
|
+
* The published OpenAPI document's server URL is `/api` and every path is
|
|
13
|
+
* relative to that prefix, so the protocol appends `/api` to the instance
|
|
14
|
+
* origin (`apiBaseUrl`).
|
|
15
|
+
*/
|
|
16
|
+
import * as Context from "effect/Context";
|
|
17
|
+
import * as Effect from "effect/Effect";
|
|
18
|
+
import * as Layer from "effect/Layer";
|
|
19
|
+
import * as Redacted from "effect/Redacted";
|
|
20
|
+
/** Grafana OSS default listen address (the instance origin, not `/api`). */
|
|
21
|
+
export declare const DEFAULT_API_BASE_URL = "http://localhost:3000";
|
|
22
|
+
export interface Config {
|
|
23
|
+
readonly token: Redacted.Redacted<string>;
|
|
24
|
+
readonly apiBaseUrl: string;
|
|
25
|
+
readonly orgId?: number | string;
|
|
26
|
+
}
|
|
27
|
+
declare const Credentials_base: Context.ServiceClass<Credentials, "GrafanaCredentials", Effect.Effect<Config, never, never>>;
|
|
28
|
+
export declare class Credentials extends Credentials_base {
|
|
29
|
+
}
|
|
30
|
+
/** Layer from a plain service-account token + optional instance URL / org. */
|
|
31
|
+
export declare const fromApiKey: (config: {
|
|
32
|
+
readonly apiKey: string;
|
|
33
|
+
readonly apiBaseUrl?: string;
|
|
34
|
+
readonly orgId?: number | string;
|
|
35
|
+
}) => Layer.Layer<Credentials>;
|
|
36
|
+
/**
|
|
37
|
+
* Reads GRAFANA_TOKEN (required), GRAFANA_URL (optional instance origin),
|
|
38
|
+
* and GRAFANA_ORG_ID (optional).
|
|
39
|
+
*/
|
|
40
|
+
export declare const CredentialsFromEnv: Layer.Layer<Credentials>;
|
|
41
|
+
export {};
|
|
42
|
+
//# sourceMappingURL=credentials.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"credentials.d.ts","sourceRoot":"","sources":["../src/credentials.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AACtC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAG5C,4EAA4E;AAC5E,eAAO,MAAM,oBAAoB,0BAA0B,CAAC;AAE5D,MAAM,WAAW,MAAM;IACrB,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC1C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAClC;;AAED,qBAAa,WAAY,SAAQ,gBAGR;CAAG;AAE5B,8EAA8E;AAC9E,eAAO,MAAM,UAAU,WAAY;IACjC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAClC,KAAG,KAAK,CAAC,KAAK,CAAC,WAAW,CAQxB,CAAC;AAEJ;;;GAGG;AACH,eAAO,MAAM,kBAAkB,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAiBvD,CAAC"}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Grafana credentials — hand-written.
|
|
3
|
+
*
|
|
4
|
+
* The `Credentials` service holds an *effect* that resolves the current
|
|
5
|
+
* credentials on every request (the protocol layer resolves it per request
|
|
6
|
+
* on the calling fiber).
|
|
7
|
+
*
|
|
8
|
+
* Grafana authenticates HTTP API requests with a service account token
|
|
9
|
+
* (`Authorization: Bearer <token>`). The optional `X-Grafana-Org-Id` header
|
|
10
|
+
* selects the organization the action applies to.
|
|
11
|
+
*
|
|
12
|
+
* The published OpenAPI document's server URL is `/api` and every path is
|
|
13
|
+
* relative to that prefix, so the protocol appends `/api` to the instance
|
|
14
|
+
* origin (`apiBaseUrl`).
|
|
15
|
+
*/
|
|
16
|
+
import * as Context from "effect/Context";
|
|
17
|
+
import * as Effect from "effect/Effect";
|
|
18
|
+
import * as Layer from "effect/Layer";
|
|
19
|
+
import * as Redacted from "effect/Redacted";
|
|
20
|
+
import { ConfigError } from "@distilled.cloud/core/errors";
|
|
21
|
+
/** Grafana OSS default listen address (the instance origin, not `/api`). */
|
|
22
|
+
export const DEFAULT_API_BASE_URL = "http://localhost:3000";
|
|
23
|
+
export class Credentials extends Context.Service()("GrafanaCredentials") {
|
|
24
|
+
}
|
|
25
|
+
/** Layer from a plain service-account token + optional instance URL / org. */
|
|
26
|
+
export const fromApiKey = (config) => Layer.succeed(Credentials, Effect.succeed({
|
|
27
|
+
token: Redacted.make(config.apiKey),
|
|
28
|
+
apiBaseUrl: config.apiBaseUrl ?? DEFAULT_API_BASE_URL,
|
|
29
|
+
orgId: config.orgId,
|
|
30
|
+
}));
|
|
31
|
+
/**
|
|
32
|
+
* Reads GRAFANA_TOKEN (required), GRAFANA_URL (optional instance origin),
|
|
33
|
+
* and GRAFANA_ORG_ID (optional).
|
|
34
|
+
*/
|
|
35
|
+
export const CredentialsFromEnv = Layer.succeed(Credentials, Effect.gen(function* () {
|
|
36
|
+
const token = process.env.GRAFANA_TOKEN;
|
|
37
|
+
if (!token) {
|
|
38
|
+
return yield* new ConfigError({
|
|
39
|
+
message: "GRAFANA_TOKEN environment variable is required",
|
|
40
|
+
});
|
|
41
|
+
}
|
|
42
|
+
return {
|
|
43
|
+
token: Redacted.make(token),
|
|
44
|
+
apiBaseUrl: process.env.GRAFANA_URL ?? DEFAULT_API_BASE_URL,
|
|
45
|
+
orgId: process.env.GRAFANA_ORG_ID,
|
|
46
|
+
};
|
|
47
|
+
}).pipe(Effect.orDie));
|
|
48
|
+
//# sourceMappingURL=credentials.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"credentials.js","sourceRoot":"","sources":["../src/credentials.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AACtC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D,4EAA4E;AAC5E,MAAM,CAAC,MAAM,oBAAoB,GAAG,uBAAuB,CAAC;AAQ5D,MAAM,OAAO,WAAY,SAAQ,OAAO,CAAC,OAAO,EAG7C,CAAC,oBAAoB,CAAC;CAAG;AAE5B,8EAA8E;AAC9E,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,MAI1B,EAA4B,EAAE,CAC7B,KAAK,CAAC,OAAO,CACX,WAAW,EACX,MAAM,CAAC,OAAO,CAAC;IACb,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IACnC,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,oBAAoB;IACrD,KAAK,EAAE,MAAM,CAAC,KAAK;CACpB,CAAC,CACH,CAAC;AAEJ;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAA6B,KAAK,CAAC,OAAO,CACvE,WAAW,EACX,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;IAExC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,KAAK,CAAC,CAAC,IAAI,WAAW,CAAC;YAC5B,OAAO,EAAE,gDAAgD;SAC1D,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;QAC3B,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,oBAAoB;QAC3D,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,cAAc;KAClC,CAAC;AACJ,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CACtB,CAAC"}
|
package/dist/errors.d.ts
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Grafana-specific error types.
|
|
3
|
+
*
|
|
4
|
+
* Re-exports the common HTTP errors from core and adds the Grafana fallback
|
|
5
|
+
* errors. Note the generated service module additionally defines its own
|
|
6
|
+
* per-status matcher classes (BadRequest/NotFound/…) for the statuses each
|
|
7
|
+
* operation declares — those share `_tag`s with the core classes here, so
|
|
8
|
+
* `catchTag` works against either.
|
|
9
|
+
*/
|
|
10
|
+
export { BadGateway, BadRequest, Conflict, ConfigError, Forbidden, GatewayTimeout, InternalServerError, Locked, NotFound, ServiceUnavailable, TooManyRequests, Unauthorized, UnprocessableEntity, HTTP_STATUS_MAP, DEFAULT_ERRORS, API_ERRORS, } from "@distilled.cloud/core/errors";
|
|
11
|
+
export type { DefaultErrors } from "@distilled.cloud/core/errors";
|
|
12
|
+
import * as Schema from "effect/Schema";
|
|
13
|
+
declare const UnknownGrafanaError_base: Schema.Class<UnknownGrafanaError, Schema.TaggedStruct<"UnknownGrafanaError", {
|
|
14
|
+
readonly code: Schema.optional<Schema.String>;
|
|
15
|
+
readonly message: Schema.optional<Schema.String>;
|
|
16
|
+
readonly body: Schema.Unknown;
|
|
17
|
+
}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
|
|
18
|
+
"@distilled.cloud/error/categories": {
|
|
19
|
+
ServerError: true;
|
|
20
|
+
};
|
|
21
|
+
});
|
|
22
|
+
/** Unknown Grafana error — returned when nothing else matches the failure. */
|
|
23
|
+
export declare class UnknownGrafanaError extends UnknownGrafanaError_base {
|
|
24
|
+
}
|
|
25
|
+
declare const GrafanaParseError_base: Schema.Class<GrafanaParseError, Schema.TaggedStruct<"GrafanaParseError", {
|
|
26
|
+
readonly body: Schema.Unknown;
|
|
27
|
+
readonly cause: Schema.Unknown;
|
|
28
|
+
}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
|
|
29
|
+
"@distilled.cloud/error/categories": {
|
|
30
|
+
ParseError: true;
|
|
31
|
+
};
|
|
32
|
+
});
|
|
33
|
+
/** Schema parse error wrapper. */
|
|
34
|
+
export declare class GrafanaParseError extends GrafanaParseError_base {
|
|
35
|
+
}
|
|
36
|
+
//# sourceMappingURL=errors.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EACL,UAAU,EACV,UAAU,EACV,QAAQ,EACR,WAAW,EACX,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,MAAM,EACN,QAAQ,EACR,kBAAkB,EAClB,eAAe,EACf,YAAY,EACZ,mBAAmB,EACnB,eAAe,EACf,cAAc,EACd,UAAU,GACX,MAAM,8BAA8B,CAAC;AACtC,YAAY,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAElE,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;;;;;;;;;;AAGxC,8EAA8E;AAC9E,qBAAa,mBAAoB,SAAQ,wBAOT;CAAG;;;;;;;;;AAEnC,kCAAkC;AAClC,qBAAa,iBAAkB,SAAQ,sBAMR;CAAG"}
|
package/dist/errors.js
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Grafana-specific error types.
|
|
3
|
+
*
|
|
4
|
+
* Re-exports the common HTTP errors from core and adds the Grafana fallback
|
|
5
|
+
* errors. Note the generated service module additionally defines its own
|
|
6
|
+
* per-status matcher classes (BadRequest/NotFound/…) for the statuses each
|
|
7
|
+
* operation declares — those share `_tag`s with the core classes here, so
|
|
8
|
+
* `catchTag` works against either.
|
|
9
|
+
*/
|
|
10
|
+
export { BadGateway, BadRequest, Conflict, ConfigError, Forbidden, GatewayTimeout, InternalServerError, Locked, NotFound, ServiceUnavailable, TooManyRequests, Unauthorized, UnprocessableEntity, HTTP_STATUS_MAP, DEFAULT_ERRORS, API_ERRORS, } from "@distilled.cloud/core/errors";
|
|
11
|
+
import * as Schema from "effect/Schema";
|
|
12
|
+
import * as Category from "@distilled.cloud/core/category";
|
|
13
|
+
/** Unknown Grafana error — returned when nothing else matches the failure. */
|
|
14
|
+
export class UnknownGrafanaError extends Schema.TaggedError()("UnknownGrafanaError", {
|
|
15
|
+
code: Schema.optional(Schema.String),
|
|
16
|
+
message: Schema.optional(Schema.String),
|
|
17
|
+
body: Schema.Unknown,
|
|
18
|
+
}).pipe(Category.withServerError) {
|
|
19
|
+
}
|
|
20
|
+
/** Schema parse error wrapper. */
|
|
21
|
+
export class GrafanaParseError extends Schema.TaggedError()("GrafanaParseError", {
|
|
22
|
+
body: Schema.Unknown,
|
|
23
|
+
cause: Schema.Unknown,
|
|
24
|
+
}).pipe(Category.withParseError) {
|
|
25
|
+
}
|
|
26
|
+
//# sourceMappingURL=errors.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EACL,UAAU,EACV,UAAU,EACV,QAAQ,EACR,WAAW,EACX,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,MAAM,EACN,QAAQ,EACR,kBAAkB,EAClB,eAAe,EACf,YAAY,EACZ,mBAAmB,EACnB,eAAe,EACf,cAAc,EACd,UAAU,GACX,MAAM,8BAA8B,CAAC;AAGtC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,QAAQ,MAAM,gCAAgC,CAAC;AAE3D,8EAA8E;AAC9E,MAAM,OAAO,mBAAoB,SAAQ,MAAM,CAAC,WAAW,EAAuB,CAChF,qBAAqB,EACrB;IACE,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACvC,IAAI,EAAE,MAAM,CAAC,OAAO;CACrB,CACF,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC;CAAG;AAEnC,kCAAkC;AAClC,MAAM,OAAO,iBAAkB,SAAQ,MAAM,CAAC,WAAW,EAAqB,CAC5E,mBAAmB,EACnB;IACE,IAAI,EAAE,MAAM,CAAC,OAAO;IACpB,KAAK,EAAE,MAAM,CAAC,OAAO;CACtB,CACF,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC;CAAG"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @distilled.cloud/grafana — Grafana HTTP API SDK for Effect.
|
|
3
|
+
*
|
|
4
|
+
* `./services` is generated by `scripts/generate.ts` from the Smithy model
|
|
5
|
+
* in `.generated-specs` (written by `scripts/convert.ts` from the OpenAPI
|
|
6
|
+
* spec). Everything else in this folder is hand-written.
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```ts
|
|
10
|
+
* import * as Grafana from "@distilled.cloud/grafana";
|
|
11
|
+
*
|
|
12
|
+
* const datasources = yield* Grafana.Services.grafana.getDataSources({});
|
|
13
|
+
* ```
|
|
14
|
+
*/
|
|
15
|
+
export * from "./credentials.ts";
|
|
16
|
+
export * from "./errors.ts";
|
|
17
|
+
export * as T from "./traits.ts";
|
|
18
|
+
export { GrafanaProtocol, type GrafanaOpError, type GrafanaOpContext, } from "./protocol.ts";
|
|
19
|
+
export { paginateCursor } from "./pagination.ts";
|
|
20
|
+
export * as Retry from "./retry.ts";
|
|
21
|
+
export * as Services from "./services/index.ts";
|
|
22
|
+
export * from "./services/grafana.ts";
|
|
23
|
+
export { BadRequest, Conflict, Forbidden, NotFound, UnprocessableEntity, } from "./services/grafana.ts";
|
|
24
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,OAAO,KAAK,CAAC,MAAM,aAAa,CAAC;AACjC,OAAO,EACL,eAAe,EACf,KAAK,cAAc,EACnB,KAAK,gBAAgB,GACtB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAC;AAChD,cAAc,uBAAuB,CAAC;AACtC,OAAO,EACL,UAAU,EACV,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,mBAAmB,GACpB,MAAM,uBAAuB,CAAC"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @distilled.cloud/grafana — Grafana HTTP API SDK for Effect.
|
|
3
|
+
*
|
|
4
|
+
* `./services` is generated by `scripts/generate.ts` from the Smithy model
|
|
5
|
+
* in `.generated-specs` (written by `scripts/convert.ts` from the OpenAPI
|
|
6
|
+
* spec). Everything else in this folder is hand-written.
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```ts
|
|
10
|
+
* import * as Grafana from "@distilled.cloud/grafana";
|
|
11
|
+
*
|
|
12
|
+
* const datasources = yield* Grafana.Services.grafana.getDataSources({});
|
|
13
|
+
* ```
|
|
14
|
+
*/
|
|
15
|
+
export * from "./credentials.js";
|
|
16
|
+
export * from "./errors.js";
|
|
17
|
+
export * as T from "./traits.js";
|
|
18
|
+
export { GrafanaProtocol, } from "./protocol.js";
|
|
19
|
+
export { paginateCursor } from "./pagination.js";
|
|
20
|
+
export * as Retry from "./retry.js";
|
|
21
|
+
export * as Services from "./services/index.js";
|
|
22
|
+
export * from "./services/grafana.js";
|
|
23
|
+
export { BadRequest, Conflict, Forbidden, NotFound, UnprocessableEntity, } from "./services/grafana.js";
|
|
24
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,OAAO,KAAK,CAAC,MAAM,aAAa,CAAC;AACjC,OAAO,EACL,eAAe,GAGhB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAC;AAChD,cAAc,uBAAuB,CAAC;AACtC,OAAO,EACL,UAAU,EACV,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,mBAAmB,GACpB,MAAM,uBAAuB,CAAC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Grafana pagination — hand-written.
|
|
3
|
+
*
|
|
4
|
+
* Grafana list endpoints mix `page`/`limit`/`perpage` query parameters and
|
|
5
|
+
* rarely return an in-body next-page token; generated operations that do
|
|
6
|
+
* not stamp `smithy.api#paginated` leave those fields as plain inputs.
|
|
7
|
+
* {@link paginateCursor} is re-exported for callers that want to drive a
|
|
8
|
+
* cursor loop themselves.
|
|
9
|
+
*/
|
|
10
|
+
export { paginateCursor } from "@distilled.cloud/core/pagination";
|
|
11
|
+
//# sourceMappingURL=pagination.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["../src/pagination.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Grafana pagination — hand-written.
|
|
3
|
+
*
|
|
4
|
+
* Grafana list endpoints mix `page`/`limit`/`perpage` query parameters and
|
|
5
|
+
* rarely return an in-body next-page token; generated operations that do
|
|
6
|
+
* not stamp `smithy.api#paginated` leave those fields as plain inputs.
|
|
7
|
+
* {@link paginateCursor} is re-exported for callers that want to drive a
|
|
8
|
+
* cursor loop themselves.
|
|
9
|
+
*/
|
|
10
|
+
export { paginateCursor } from "@distilled.cloud/core/pagination";
|
|
11
|
+
//# sourceMappingURL=pagination.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pagination.js","sourceRoot":"","sources":["../src/pagination.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type * as Layer from "effect/Layer";
|
|
2
|
+
import type * as HttpClient from "effect/unstable/http/HttpClient";
|
|
3
|
+
import type * as HttpClientError from "effect/unstable/http/HttpClientError";
|
|
4
|
+
import type * as API from "@distilled.cloud/core/api";
|
|
5
|
+
import type { API_ERRORS, ConfigError } from "@distilled.cloud/core/errors";
|
|
6
|
+
import { Credentials } from "./credentials.ts";
|
|
7
|
+
import { UnknownGrafanaError } from "./errors.ts";
|
|
8
|
+
/**
|
|
9
|
+
* Error channel shared by every generated Grafana operation. Generated
|
|
10
|
+
* service files annotate operations with `API.OperationMethod<I, O,
|
|
11
|
+
* GrafanaOpError, GrafanaOpContext>` explicitly so the compiler never infers
|
|
12
|
+
* these back out of the schema generics.
|
|
13
|
+
*/
|
|
14
|
+
export type GrafanaOpError = InstanceType<(typeof API_ERRORS)[number]> | UnknownGrafanaError | ConfigError | HttpClientError.HttpClientError;
|
|
15
|
+
/** Context (requirements) shared by every generated Grafana operation. */
|
|
16
|
+
export type GrafanaOpContext = Credentials | HttpClient.HttpClient;
|
|
17
|
+
export declare const GrafanaProtocol: Layer.Layer<API.Protocol>;
|
|
18
|
+
//# sourceMappingURL=protocol.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAC;AAE3C,OAAO,KAAK,KAAK,UAAU,MAAM,iCAAiC,CAAC;AACnE,OAAO,KAAK,KAAK,eAAe,MAAM,sCAAsC,CAAC;AAC7E,OAAO,KAAK,KAAK,GAAG,MAAM,2BAA2B,CAAC;AAEtD,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAe,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAElD;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GACtB,YAAY,CAAC,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,GACzC,mBAAmB,GACnB,WAAW,GACX,eAAe,CAAC,eAAe,CAAC;AAEpC,0EAA0E;AAC1E,MAAM,MAAM,gBAAgB,GAAG,WAAW,GAAG,UAAU,CAAC,UAAU,CAAC;AAQnE,eAAO,MAAM,eAAe,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAgClD,CAAC"}
|
package/dist/protocol.js
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* GrafanaProtocol — hand-written.
|
|
3
|
+
*
|
|
4
|
+
* Grafana speaks bearer-authenticated JSON REST (no response envelope),
|
|
5
|
+
* so the whole protocol is one `makeRestProtocol` call from
|
|
6
|
+
* `core/protocol-rest`:
|
|
7
|
+
*
|
|
8
|
+
* request: credentials → `Authorization: Bearer <token>` + optional
|
|
9
|
+
* `X-Grafana-Org-Id`, resolved from the calling fiber on every
|
|
10
|
+
* request. Paths in the spec are relative to `/api`, so the
|
|
11
|
+
* instance origin is joined with that prefix.
|
|
12
|
+
*
|
|
13
|
+
* response: 2xx JSON is the payload (sensitive members delivered as
|
|
14
|
+
* `Redacted`); non-2xx `{ message?, status? }` bodies map to the
|
|
15
|
+
* operation's typed error classes by status, then the shared
|
|
16
|
+
* HTTP-status classes, then {@link UnknownGrafanaError}.
|
|
17
|
+
*/
|
|
18
|
+
import * as Effect from "effect/Effect";
|
|
19
|
+
import * as Redacted from "effect/Redacted";
|
|
20
|
+
import { makeRestProtocol } from "@distilled.cloud/core/protocol-rest";
|
|
21
|
+
import { Credentials } from "./credentials.js";
|
|
22
|
+
import { UnknownGrafanaError } from "./errors.js";
|
|
23
|
+
/** Join the instance origin with `/api` unless the caller already included it. */
|
|
24
|
+
const apiBaseUrl = (origin) => {
|
|
25
|
+
const trimmed = origin.replace(/\/+$/, "");
|
|
26
|
+
return trimmed.endsWith("/api") ? trimmed : `${trimmed}/api`;
|
|
27
|
+
};
|
|
28
|
+
export const GrafanaProtocol = makeRestProtocol({
|
|
29
|
+
// The Credentials service holds an effect — resolving it here (per
|
|
30
|
+
// request, on the calling fiber) picks up context-provided credentials.
|
|
31
|
+
credentials: Effect.gen(function* () {
|
|
32
|
+
const resolve = yield* Credentials;
|
|
33
|
+
return yield* resolve;
|
|
34
|
+
}),
|
|
35
|
+
baseUrl: (creds) => apiBaseUrl(creds.apiBaseUrl),
|
|
36
|
+
headers: (creds) => {
|
|
37
|
+
const headers = {
|
|
38
|
+
Authorization: `Bearer ${Redacted.value(creds.token)}`,
|
|
39
|
+
Accept: "application/json",
|
|
40
|
+
};
|
|
41
|
+
if (creds.orgId !== undefined) {
|
|
42
|
+
headers["X-Grafana-Org-Id"] = String(creds.orgId);
|
|
43
|
+
}
|
|
44
|
+
return headers;
|
|
45
|
+
},
|
|
46
|
+
// Grafana's error body is `{ message?: string, status?: string }` — the
|
|
47
|
+
// factory's default lenient envelope covers it.
|
|
48
|
+
unknownError: ({ code, message, body }) => new UnknownGrafanaError({
|
|
49
|
+
code: typeof code === "string"
|
|
50
|
+
? code
|
|
51
|
+
: code !== undefined
|
|
52
|
+
? String(code)
|
|
53
|
+
: undefined,
|
|
54
|
+
message,
|
|
55
|
+
body,
|
|
56
|
+
}),
|
|
57
|
+
});
|
|
58
|
+
//# sourceMappingURL=protocol.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAI5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AAEvE,OAAO,EAAE,WAAW,EAAe,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAiBlD,kFAAkF;AAClF,MAAM,UAAU,GAAG,CAAC,MAAc,EAAU,EAAE;IAC5C,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC3C,OAAO,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,MAAM,CAAC;AAC/D,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAC1B,gBAAgB,CAAS;IACvB,mEAAmE;IACnE,wEAAwE;IACxE,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QAC/B,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,WAAW,CAAC;QACnC,OAAO,KAAK,CAAC,CAAC,OAAO,CAAC;IACxB,CAAC,CAAC;IACF,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC;IAChD,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;QACjB,MAAM,OAAO,GAA2B;YACtC,aAAa,EAAE,UAAU,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;YACtD,MAAM,EAAE,kBAAkB;SAC3B,CAAC;QACF,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,CAAC,kBAAkB,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,wEAAwE;IACxE,gDAAgD;IAChD,YAAY,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CACxC,IAAI,mBAAmB,CAAC;QACtB,IAAI,EACF,OAAO,IAAI,KAAK,QAAQ;YACtB,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,IAAI,KAAK,SAAS;gBAClB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;gBACd,CAAC,CAAC,SAAS;QACjB,OAAO;QACP,IAAI;KACL,CAAC;CACL,CAAC,CAAC"}
|