@stacksjs/types 0.75.561 → 0.75.568

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.
@@ -62,13 +62,15 @@ export declare interface DashboardOptions {
62
62
  providers?: DashboardProviderOptions
63
63
  }
64
64
  /**
65
- * Credentials and endpoint for a hosted HQ product.
65
+ * Per-section overrides for a hosted HQ product.
66
66
  *
67
- * `token` must be a READ token. A product's ingest key (the `loghq_...` value
68
- * an app uses to SEND logs) grants no read access at all, so pasting one here
69
- * produces an unauthorized response rather than data. The hosted read APIs
70
- * currently authenticate a user rather than a machine, which is why this is
71
- * separate from whatever ingest key `config/logging.ts` carries.
67
+ * All optional. A section set to `hq` reads with the URL, read key and
68
+ * project in `config/services.ts`, which `buddy hq:connect` fills in. Set a field
69
+ * here only to point one section somewhere else.
70
+ *
71
+ * `token` must be a READ key. A product's ingest key (the value an app uses to
72
+ * SEND logs) grants no read access at all, so pasting one here produces an
73
+ * empty section rather than data.
72
74
  */
73
75
  export declare interface DashboardHqDriverOptions {
74
76
  baseUrl?: string
@@ -1,3 +1,11 @@
1
+ /** One HQ service's entry in `config/services.ts`, written by `buddy hq:connect`. */
2
+ export declare interface HqServiceOptions {
3
+ url: string
4
+ key?: string
5
+ readKey?: string
6
+ project?: string
7
+ license?: string
8
+ }
1
9
  export declare interface ServicesOptions {
2
10
  algolia?: {
3
11
  appId: string
@@ -154,5 +162,21 @@ export declare interface ServicesOptions {
154
162
  apiKey?: string
155
163
  apiVersion?: string
156
164
  }
165
+ bughq?: HqServiceOptions
166
+ loghq?: HqServiceOptions
167
+ analyticshq?: HqServiceOptions
168
+ statushq?: HqServiceOptions
169
+ commshq?: HqServiceOptions
170
+ reportshq?: HqServiceOptions
157
171
  }
172
+ /**
173
+ * The HQ services an application can connect to.
174
+ *
175
+ * They are separate products. Each keeps its own account, keys, plan and
176
+ * subscription, so every service carries its own credentials and nothing is
177
+ * shared between them.
178
+ */
179
+ export type HqServiceName = 'bughq' | 'loghq' | 'analyticshq' | 'statushq' | 'commshq' | 'reportshq';
180
+ /** The HQ entries of `config/services.ts`, on their own. */
181
+ export type HqServicesConfig = Partial<Record<HqServiceName, HqServiceOptions>>;
158
182
  export type ServicesConfig = Partial<ServicesOptions>;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@stacksjs/types",
3
3
  "type": "module",
4
- "version": "0.75.561",
4
+ "version": "0.75.568",
5
5
  "description": "The Stacks framework types.",
6
6
  "author": "Chris Breuer",
7
7
  "contributors": [
@@ -64,16 +64,16 @@
64
64
  "dependencies": {
65
65
  "@stacksjs/bunpress": "^0.2.15",
66
66
  "@stacksjs/clapp": "^0.2.17",
67
- "@stacksjs/events": "0.75.561",
68
- "@stacksjs/strings": "0.75.561",
67
+ "@stacksjs/events": "0.75.568",
68
+ "@stacksjs/strings": "0.75.568",
69
69
  "@stacksjs/stx": "^0.2.864",
70
70
  "@stacksjs/ts-validation": "^0.5.7",
71
- "bun-query-builder": "^0.3.44",
71
+ "bun-query-builder": "^0.4.1",
72
72
  "meilisearch": "^0.62.0",
73
73
  "stripe": "23.0.0"
74
74
  },
75
75
  "devDependencies": {
76
- "@stacksjs/validation": "0.75.561",
76
+ "@stacksjs/validation": "0.75.568",
77
77
  "better-dx": "^0.2.24"
78
78
  },
79
79
  "sideEffects": false,
@@ -99,7 +99,7 @@
99
99
  }
100
100
  },
101
101
  "peerDependencies": {
102
- "@stacksjs/actions": "0.75.561",
103
- "@stacksjs/scheduler": "0.75.561"
102
+ "@stacksjs/actions": "0.75.568",
103
+ "@stacksjs/scheduler": "0.75.568"
104
104
  }
105
105
  }