@trackunit/serverside-utils 0.4.77 → 0.5.0

package/README.md

@@ -9,9 +9,60 @@ For more info and a full guide on Iris App SDK Development, please visit our [De
 ## Installation
 
 ```bash
-yarn add @trackunit/serverside-utils
+npm install @trackunit/serverside-utils
 ```
 
+## Authenticated Trackunit public GraphQL
+
+`createTrackunitGraphqlClient` is only for the Trackunit public GraphQL API.
+
+Set up GraphQL and define one named operation per `.graphql` file:
+
+```bash
+npx nx generate @trackunit/react-graphql-tools:add-graphql --project=<project>
+npx nx run <project>:graphql-hooks
+```
+
+```graphql
+# src/graphql/asset-by-id.graphql
+query AssetById($id: ID!) {
+  asset(id: $id) {
+    id
+    name
+  }
+}
+```
+
+Run `graphql-hooks` after changing an operation, then use the generated document:
+
+```typescript
+import { createTrackunitGraphqlClient } from "@trackunit/serverside-utils";
+import { Hono } from "hono";
+import { AssetByIdDocument } from "./generated/graphql-api/graphql";
+
+const app = new Hono();
+
+app.get("/assets/:id", async c => {
+  const client = createTrackunitGraphqlClient({ context: c });
+  const data = await client.request({
+    document: AssetByIdDocument,
+    variables: { id: c.req.param("id") },
+    signal: c.req.raw.signal,
+  });
+
+  return c.json(data);
+});
+
+export default app.fetch;
+```
+
+### Behavior
+
+- The Hono context supplies the requesting user's authentication. Missing authentication throws `Missing user token` before any request.
+- `SDK_ENVIRONMENT` selects the Trackunit public endpoint for `DEV`, `STAGE`, or `PROD`; unset defaults to `PROD`.
+- `request({ document, variables, signal? })` infers data and variable types from the generated `TypedDocumentNode`. Generated types do not validate responses at runtime. `signal` cancels the request.
+- Transport, HTTP, and GraphQL errors propagate from the shared client (e.g. `graphql-request`'s `ClientError`).
+
 ## Trackunit
 
 This package was developed by Trackunit ApS.

package/index.cjs.js

@@ -1,5 +1,6 @@
 'use strict';
 
+var serverGraphqlClient = require('@trackunit/server-graphql-client');
 var zod = require('zod');
 var jwtDecode = require('jwt-decode');
 
@@ -161,6 +162,22 @@ const getUserToken = ({ context }) => {
     return undefined;
 };
 
+/**
+ * Creates a typed public Trackunit GraphQL client authenticated as the requesting user.
+ */
+const createTrackunitGraphqlClient = ({ context }) => {
+    const userToken = getUserToken({ context });
+    if (!userToken) {
+        throw new Error("Missing user token");
+    }
+    return serverGraphqlClient.createServerGraphqlClient({
+        baseUrl: getGraphqlUrl(),
+        name: "trackunit-graphql-client",
+        headers: { Authorization: `Bearer ${userToken}` },
+        resolveUrl: serverGraphqlClient.operationNameUrlResolver,
+    });
+};
+
 const JwtAccountPayloadSchema = zod.z.object({
     accountId: zod.z.string().optional(),
     assumedAccountId: zod.z.string().optional(),
@@ -504,6 +521,7 @@ const requireScopes = (scopes, options = {}) => {
 
 exports.ACCOUNT_ADMIN_IRIS_APP_TOKEN_HEADER = ACCOUNT_ADMIN_IRIS_APP_TOKEN_HEADER;
 exports.FORWARDED_AUTHORIZATION_HEADER = FORWARDED_AUTHORIZATION_HEADER;
+exports.createTrackunitGraphqlClient = createTrackunitGraphqlClient;
 exports.executePublicQuery = executePublicQuery;
 exports.getAccountId = getAccountId;
 exports.getDatabricksAccessToken = getDatabricksAccessToken;

package/index.esm.js

@@ -1,3 +1,4 @@
+import { createServerGraphqlClient, operationNameUrlResolver } from '@trackunit/server-graphql-client';
 import { z } from 'zod';
 import jwtDecode from 'jwt-decode';
 
@@ -159,6 +160,22 @@ const getUserToken = ({ context }) => {
     return undefined;
 };
 
+/**
+ * Creates a typed public Trackunit GraphQL client authenticated as the requesting user.
+ */
+const createTrackunitGraphqlClient = ({ context }) => {
+    const userToken = getUserToken({ context });
+    if (!userToken) {
+        throw new Error("Missing user token");
+    }
+    return createServerGraphqlClient({
+        baseUrl: getGraphqlUrl(),
+        name: "trackunit-graphql-client",
+        headers: { Authorization: `Bearer ${userToken}` },
+        resolveUrl: operationNameUrlResolver,
+    });
+};
+
 const JwtAccountPayloadSchema = z.object({
     accountId: z.string().optional(),
     assumedAccountId: z.string().optional(),
@@ -500,4 +517,4 @@ const requireScopes = (scopes, options = {}) => {
     };
 };
 
-export { ACCOUNT_ADMIN_IRIS_APP_TOKEN_HEADER, FORWARDED_AUTHORIZATION_HEADER, executePublicQuery, getAccountId, getDatabricksAccessToken, getGraphqlUrl, getSecret, getUserToken, hasScopes, requireScopes };
+export { ACCOUNT_ADMIN_IRIS_APP_TOKEN_HEADER, FORWARDED_AUTHORIZATION_HEADER, createTrackunitGraphqlClient, executePublicQuery, getAccountId, getDatabricksAccessToken, getGraphqlUrl, getSecret, getUserToken, hasScopes, requireScopes };

package/package.json

@@ -1,16 +1,18 @@
 {
   "name": "@trackunit/serverside-utils",
-  "version": "0.4.77",
+  "version": "0.5.0",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
     "node": ">=24.x"
   },
   "dependencies": {
+    "@trackunit/server-graphql-client": "0.0.1",
     "jwt-decode": "^3.1.2",
     "zod": "^3.25.76"
   },
   "peerDependencies": {
+    "graphql": "^16.10.0",
     "hono": "^4.12.12"
   },
   "migrations": "./migrations.json",

package/src/create-trackunit-graphql-client.d.ts

@@ -0,0 +1,10 @@
+import { type ServerGraphqlClient } from "@trackunit/server-graphql-client";
+import type { Context } from "hono";
+export type CreateTrackunitGraphqlClientProps = {
+    readonly context: Context;
+};
+export type TrackunitGraphqlClient = ServerGraphqlClient;
+/**
+ * Creates a typed public Trackunit GraphQL client authenticated as the requesting user.
+ */
+export declare const createTrackunitGraphqlClient: ({ context }: CreateTrackunitGraphqlClientProps) => TrackunitGraphqlClient;

package/src/index.d.ts

@@ -1,3 +1,4 @@
+export { createTrackunitGraphqlClient, type CreateTrackunitGraphqlClientProps, type TrackunitGraphqlClient, } from "./create-trackunit-graphql-client";
 export { executePublicQuery, getGraphqlUrl, type ExecutePublicQueryProps } from "./execute-public-query";
 export { getAccountId } from "./get-account-id";
 export { getDatabricksAccessToken, type GetDatabricksAccessTokenProps } from "./get-databricks-access-token";