@picked/admin-api-client 0.0.111-next.3 → 0.0.111-next.4
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 +7 -2
- package/dist/.tsbuildinfo +1 -1
- package/dist/cjs/index.js +68 -8
- package/dist/esm/index.js +12 -7
- package/dist/types/app-installation.d.ts +121 -0
- package/dist/types/app-installation.d.ts.map +1 -0
- package/dist/types/client.d.ts +5 -1
- package/dist/types/client.d.ts.map +1 -1
- package/dist/types/graphql-env.d.ts +47 -8
- package/dist/types/index.d.ts +1 -0
- package/dist/types/index.d.ts.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -36,13 +36,18 @@ const data = await client.request(MeQuery, {})
|
|
|
36
36
|
| `apiUrl` | The Picked API origin. |
|
|
37
37
|
| `token` | A bearer token, or a function that returns one for each request. |
|
|
38
38
|
| `apiKey` | An API key, sent as `X-API-Key`. |
|
|
39
|
+
| `fetch` | The fetch requests are sent with. The global `fetch` by default. |
|
|
39
40
|
|
|
40
41
|
A request times out after 30 seconds; `client.request(document, variables, { timeoutMs })`
|
|
41
|
-
changes that.
|
|
42
|
+
changes that. `{ headers }` adds headers to one request, over the `token` and `apiKey`
|
|
43
|
+
headers. GraphQL errors throw an `AdminApiResponseError` whose `codes` holds each
|
|
42
44
|
error's `extensions.code`; other failures throw an `Error`.
|
|
43
45
|
|
|
44
46
|
The package also exports the documents that move a workspace between projects, such as
|
|
45
|
-
`WorkspaceExportDocument` and `WorkspaceImportDocument
|
|
47
|
+
`WorkspaceExportDocument` and `WorkspaceImportDocument`, and the documents an app server sends
|
|
48
|
+
as one installation: `AppInstallationLabelsDocument`, `LabelsSetDocument`,
|
|
49
|
+
`LabelsDeleteDocument` and `AppInstallationTokenCreateDocument`. `@picked/app-kit`'s
|
|
50
|
+
installation client sends them.
|
|
46
51
|
|
|
47
52
|
## Docs
|
|
48
53
|
|