@tsg-dsp/tsg-sdk 0.0.0-stage → 0.20.1

package/dist/client.js

@@ -0,0 +1,107 @@
+/**
+ * Typed API clients powered by openapi-fetch and generated OpenAPI types.
+ *
+ * The generated types in `.generated/` contain all path definitions, request
+ * parameters, and response schemas derived from the NestJS controller OpenAPI
+ * specs.  openapi-fetch uses those types to provide compile-time validation of
+ * every HTTP call the SDK makes.
+ */
+import createClient from "openapi-fetch";
+import { createRequestError } from "./utils/errors.js";
+// ── Middleware ──────────────────────────────────────────────────────────────
+/**
+ * Creates middleware that attaches an `Authorization: Bearer <token>` header
+ * to every outgoing request using the given {@link AuthProvider}.
+ * @param authProvider - Provider that supplies access tokens.
+ * @returns An openapi-fetch {@link Middleware} instance.
+ * @internal
+ */
+function authMiddleware(authProvider) {
+    return {
+        async onRequest({ request }) {
+            const headers = await authProvider.getAuthHeaders();
+            for (const [key, value] of Object.entries(headers)) {
+                request.headers.set(key, value);
+            }
+            return request;
+        }
+    };
+}
+/**
+ * Creates middleware that sets the `X-Tenant-Slug` header on every request, so
+ * the control plane / wallet scopes it to the given tenant.
+ * @param tenantSlug - Slug of the tenant to address.
+ * @returns An openapi-fetch {@link Middleware} instance.
+ * @internal
+ */
+function tenantMiddleware(tenantSlug) {
+    return {
+        async onRequest({ request }) {
+            request.headers.set("X-Tenant-Slug", tenantSlug);
+            return request;
+        }
+    };
+}
+/**
+ * Middleware that intercepts non-OK HTTP responses and converts them into
+ * typed {@link SdkError} instances with the appropriate {@link SdkErrorCode}.
+ * @internal
+ */
+const errorMiddleware = {
+    async onResponse({ response }) {
+        if (!response.ok) {
+            const body = await response
+                .clone()
+                .text()
+                .catch(() => "");
+            throw createRequestError(`Request failed (${response.status}): ${body}`, response.status);
+        }
+        return response;
+    }
+};
+// ── Client factories ───────────────────────────────────────────────────────
+/**
+ * Create a typed HTTP client for the TSG Control Plane API.
+ * @param baseUrl - Base URL of the control plane (e.g. `"http://localhost:3501"`).
+ * @param authProvider - Provider that supplies access tokens for authenticated requests.
+ * @param tenantSlug - Optional tenant slug sent as `X-Tenant-Slug` on every request.
+ * @returns A fully typed openapi-fetch client bound to the control plane OpenAPI schema.
+ */
+export function createControlPlaneClient(baseUrl, authProvider, tenantSlug) {
+    const client = createClient({ baseUrl });
+    client.use(authMiddleware(authProvider));
+    if (tenantSlug) {
+        client.use(tenantMiddleware(tenantSlug));
+    }
+    client.use(errorMiddleware);
+    return client;
+}
+/**
+ * Create a typed HTTP client for the TSG Wallet API.
+ * @param baseUrl - Base URL of the wallet (e.g. `"http://localhost:3500"`).
+ * @param authProvider - Provider that supplies access tokens for authenticated requests.
+ * @param tenantSlug - Optional tenant slug sent as `X-Tenant-Slug` on every request.
+ * @returns A fully typed openapi-fetch client bound to the wallet OpenAPI schema.
+ */
+export function createWalletClient(baseUrl, authProvider, tenantSlug) {
+    const client = createClient({ baseUrl });
+    client.use(authMiddleware(authProvider));
+    if (tenantSlug) {
+        client.use(tenantMiddleware(tenantSlug));
+    }
+    client.use(errorMiddleware);
+    return client;
+}
+/**
+ * Create a typed HTTP client for the TSG SSO Bridge API.
+ * @param baseUrl - Base URL of the SSO bridge (e.g. `"http://localhost:3700"`).
+ * @param authProvider - Provider that supplies access tokens for authenticated requests.
+ * @returns A fully typed openapi-fetch client bound to the SSO bridge OpenAPI schema.
+ */
+export function createSsoBridgeClient(baseUrl, authProvider) {
+    const client = createClient({ baseUrl });
+    client.use(authMiddleware(authProvider));
+    client.use(errorMiddleware);
+    return client;
+}
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,YAA8C,MAAM,eAAe,CAAC;AAM3E,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAEvD,+EAA+E;AAE/E;;;;;;GAMG;AACH,SAAS,cAAc,CAAC,YAA0B;IAChD,OAAO;QACL,KAAK,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE;YACzB,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,cAAc,EAAE,CAAC;YACpD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;gBACnD,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAClC,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,gBAAgB,CAAC,UAAkB;IAC1C,OAAO;QACL,KAAK,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE;YACzB,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;YACjD,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,eAAe,GAAe;IAClC,KAAK,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE;QAC3B,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,GAAG,MAAM,QAAQ;iBACxB,KAAK,EAAE;iBACP,IAAI,EAAE;iBACN,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;YACnB,MAAM,kBAAkB,CACtB,mBAAmB,QAAQ,CAAC,MAAM,MAAM,IAAI,EAAE,EAC9C,QAAQ,CAAC,MAAM,CAChB,CAAC;QACJ,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF,CAAC;AAEF,8EAA8E;AAE9E;;;;;;GAMG;AACH,MAAM,UAAU,wBAAwB,CACtC,OAAe,EACf,YAA0B,EAC1B,UAAmB;IAEnB,MAAM,MAAM,GAAG,YAAY,CAAoB,EAAE,OAAO,EAAE,CAAC,CAAC;IAC5D,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC;IACzC,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;IAC3C,CAAC;IACD,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IAC5B,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAe,EACf,YAA0B,EAC1B,UAAmB;IAEnB,MAAM,MAAM,GAAG,YAAY,CAAc,EAAE,OAAO,EAAE,CAAC,CAAC;IACtD,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC;IACzC,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;IAC3C,CAAC;IACD,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IAC5B,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CACnC,OAAe,EACf,YAA0B;IAE1B,MAAM,MAAM,GAAG,YAAY,CAAiB,EAAE,OAAO,EAAE,CAAC,CAAC;IACzD,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC;IACzC,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IAC5B,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/config/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./sdk.config.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/config/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/config/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC"}

package/dist/config/index.js

@@ -0,0 +1,2 @@
+export * from "./sdk.config.js";
+//# sourceMappingURL=index.js.map

package/dist/config/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/config/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC"}

package/dist/config/sdk.config.d.ts

@@ -0,0 +1,81 @@
+/**
+ * Configuration for creating a {@link TsgSdk} instance.
+ *
+ * Only `controlPlaneBaseUrl` is required. Provide `walletBaseUrl` and/or
+ * `ssoBridgeBaseUrl` to enable the corresponding SDK modules.
+ * @example
+ * ```ts
+ * const config: TsgSdkConfig = {
+ *   controlPlaneBaseUrl: "http://localhost:3501",
+ *   walletBaseUrl: "http://localhost:3500",
+ *   ssoBridgeBaseUrl: "http://localhost:3700",
+ *   tenantSlug: "default",
+ *   auth: {
+ *     method: "client_secret_post",
+ *     clientId: "my-client",
+ *     clientSecret: "my-secret",
+ *   },
+ * };
+ * ```
+ */
+export interface TsgSdkConfig {
+    /** Base URL of the control plane (e.g. "http://localhost:3501" or "http://localhost:3501/api" when the /api prefix is enabled) */
+    controlPlaneBaseUrl: string;
+    /**
+     * Tenant to address on the control plane and wallet. Sent as the
+     * `X-Tenant-Slug` header on every request. Required unless the deployment
+     * resolves the tenant another way (e.g. a browser session).
+     */
+    tenantSlug?: string;
+    /** Base URL of the wallet (e.g. "http://localhost:3500" or "http://localhost:3500/api"). Optional - wallet features disabled if not provided. */
+    walletBaseUrl?: string;
+    /** Base URL of the SSO bridge (e.g. "http://localhost:3700" or "http://localhost:3700/api"). Required for auth. OpenID discovery preserves the deployment path and removes a trailing /api. */
+    ssoBridgeBaseUrl?: string;
+    /** Authentication configuration. If omitted, requests are sent without auth. */
+    auth?: TsgSdkAuthConfig;
+}
+/**
+ * Authentication configuration for the SDK.
+ *
+ * Exactly one of the following strategies must be chosen:
+ * - {@link ClientSecretAuthConfig} — OAuth 2.0 client credentials with a client secret.
+ * - {@link PrivateKeyJwtAuthConfig} — OAuth 2.0 client credentials using a private key JWT assertion.
+ * - {@link AccessTokenAuthConfig} — A pre-obtained bearer token.
+ */
+export type TsgSdkAuthConfig = ClientSecretAuthConfig | PrivateKeyJwtAuthConfig | AccessTokenAuthConfig;
+/**
+ * Authenticate using the OAuth 2.0 `client_credentials` grant with a
+ * client ID and client secret sent via POST body.
+ */
+export interface ClientSecretAuthConfig {
+    method: "client_secret_post";
+    clientId: string;
+    clientSecret: string;
+    /** OpenID configuration URL. Defaults to `${ssoBridgeBaseUrl}/.well-known/openid-configuration` */
+    openIdConfigurationUrl?: string;
+}
+/**
+ * Authenticate using the OAuth 2.0 `client_credentials` grant with a
+ * signed JWT assertion (`private_key_jwt` client authentication method).
+ *
+ * Supported key types: EC (P-256 / P-384), OKP (Ed25519), and RSA.
+ */
+export interface PrivateKeyJwtAuthConfig {
+    method: "private_key_jwt";
+    clientId: string;
+    privateKeyJwk: JsonWebKey;
+    /** OpenID configuration URL. Defaults to `${ssoBridgeBaseUrl}/.well-known/openid-configuration` */
+    openIdConfigurationUrl?: string;
+}
+/**
+ * Skip token acquisition and use a pre-obtained access token directly.
+ *
+ * Useful for short-lived scripts or when tokens are managed externally.
+ * The SDK will not attempt to refresh the token when it expires.
+ */
+export interface AccessTokenAuthConfig {
+    method: "access_token";
+    /** A pre-obtained access token to use directly */
+    accessToken: string;
+}
+//# sourceMappingURL=sdk.config.d.ts.map

package/dist/config/sdk.config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdk.config.d.ts","sourceRoot":"","sources":["../../src/config/sdk.config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,YAAY;IAC3B,kIAAkI;IAClI,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,iJAAiJ;IACjJ,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,+LAA+L;IAC/L,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,gFAAgF;IAChF,IAAI,CAAC,EAAE,gBAAgB,CAAC;CACzB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GAC1B,sBAAsB,GAAG,uBAAuB,GAAG,qBAAqB,CAAC;AAE3E;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,oBAAoB,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,mGAAmG;IACnG,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,iBAAiB,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,UAAU,CAAC;IAC1B,mGAAmG;IACnG,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,cAAc,CAAC;IACvB,kDAAkD;IAClD,WAAW,EAAE,MAAM,CAAC;CACrB"}

package/dist/config/sdk.config.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=sdk.config.js.map

package/dist/config/sdk.config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdk.config.js","sourceRoot":"","sources":["../../src/config/sdk.config.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+export { TsgSdk } from "./tsg-sdk.js";
+export * from "./config/index.js";
+export * from "./client.js";
+export * from "./auth/index.js";
+export { AssetConfigDto, CatalogSchema, ContractNegotiationSchema, DataPlaneDetailsDto, DatasetDto, DatasetManagementStateDto, DatasetSchema, DatasetStateUpdateDto, DatasetSubmissionDto, DatasetSubmissionResponseDto, defaultContext, TransferDetailDto, TransferProcessSchema } from "@tsg-dsp/common-dsp";
+export { CredentialClaimConstraint, CredentialRequirement, CredentialRequirementSet, CredentialRequirementSetCreate, DIDDocumentDto, NegotiationDetailDto, NegotiationStatusDto, ProfileRef, RequirementEvaluation, ServiceDto, SignedJwtResponse, VersionedRef } from "./vendor/common-dtos/index.js";
+export { ChangePasswordDto, ClientDto, CreateClientDto, CreateUserDto, UpdateClientDto, UpdateUserDto, UserDto, UserWithPasswordDto } from "./vendor/sso-bridge-dtos/index.js";
+export { CredentialOffer, CredentialOfferStatus, KeyInfo } from "./vendor/wallet-dtos/index.js";
+export * from "./catalog/index.js";
+export * from "./metadata/index.js";
+export * from "./negotiations/index.js";
+export * from "./requirements/index.js";
+export * from "./sso/index.js";
+export * from "./transfers/index.js";
+export * from "./wallet/index.js";
+export * from "./utils/index.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAGtC,cAAc,mBAAmB,CAAC;AAGlC,cAAc,aAAa,CAAC;AAG5B,cAAc,iBAAiB,CAAC;AAGhC,OAAO,EACL,cAAc,EACd,aAAa,EACb,yBAAyB,EACzB,mBAAmB,EACnB,UAAU,EACV,yBAAyB,EACzB,aAAa,EACb,qBAAqB,EACrB,oBAAoB,EACpB,4BAA4B,EAC5B,cAAc,EACd,iBAAiB,EACjB,qBAAqB,EACtB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,yBAAyB,EACzB,qBAAqB,EACrB,wBAAwB,EACxB,8BAA8B,EAC9B,cAAc,EACd,oBAAoB,EACpB,oBAAoB,EACpB,UAAU,EACV,qBAAqB,EACrB,UAAU,EACV,iBAAiB,EACjB,YAAY,EACb,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,iBAAiB,EACjB,SAAS,EACT,eAAe,EACf,aAAa,EACb,eAAe,EACf,aAAa,EACb,OAAO,EACP,mBAAmB,EACpB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,OAAO,EACR,MAAM,sBAAsB,CAAC;AAG9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAGlC,cAAc,kBAAkB,CAAC"}

package/dist/index.js

@@ -0,0 +1,24 @@
+// Main facade
+export { TsgSdk } from "./tsg-sdk.js";
+// Configuration
+export * from "./config/index.js";
+// Typed API clients
+export * from "./client.js";
+// Auth
+export * from "./auth/index.js";
+// Re-export DTOs from monorepo packages used for validation
+export { AssetConfigDto, CatalogSchema, ContractNegotiationSchema, DataPlaneDetailsDto, DatasetManagementStateDto, DatasetSchema, DatasetStateUpdateDto, DatasetSubmissionDto, DatasetSubmissionResponseDto, defaultContext, TransferDetailDto, TransferProcessSchema } from "@tsg-dsp/common-dsp";
+export { CredentialClaimConstraint, CredentialRequirement, CredentialRequirementSet, CredentialRequirementSetCreate, DIDDocumentDto, NegotiationDetailDto, NegotiationStatusDto, ProfileRef, RequirementEvaluation, ServiceDto, SignedJwtResponse, VersionedRef } from "./vendor/common-dtos/index.js";
+export { ChangePasswordDto, ClientDto, CreateClientDto, CreateUserDto, UpdateClientDto, UpdateUserDto, UserDto, UserWithPasswordDto } from "./vendor/sso-bridge-dtos/index.js";
+export { CredentialOffer, CredentialOfferStatus, KeyInfo } from "./vendor/wallet-dtos/index.js";
+// SDK modules
+export * from "./catalog/index.js";
+export * from "./metadata/index.js";
+export * from "./negotiations/index.js";
+export * from "./requirements/index.js";
+export * from "./sso/index.js";
+export * from "./transfers/index.js";
+export * from "./wallet/index.js";
+// Utilities
+export * from "./utils/index.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc;AACd,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC,gBAAgB;AAChB,cAAc,mBAAmB,CAAC;AAElC,oBAAoB;AACpB,cAAc,aAAa,CAAC;AAE5B,OAAO;AACP,cAAc,iBAAiB,CAAC;AAEhC,4DAA4D;AAC5D,OAAO,EACL,cAAc,EACd,aAAa,EACb,yBAAyB,EACzB,mBAAmB,EAEnB,yBAAyB,EACzB,aAAa,EACb,qBAAqB,EACrB,oBAAoB,EACpB,4BAA4B,EAC5B,cAAc,EACd,iBAAiB,EACjB,qBAAqB,EACtB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,yBAAyB,EACzB,qBAAqB,EACrB,wBAAwB,EACxB,8BAA8B,EAC9B,cAAc,EACd,oBAAoB,EACpB,oBAAoB,EACpB,UAAU,EACV,qBAAqB,EACrB,UAAU,EACV,iBAAiB,EACjB,YAAY,EACb,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,iBAAiB,EACjB,SAAS,EACT,eAAe,EACf,aAAa,EACb,eAAe,EACf,aAAa,EACb,OAAO,EACP,mBAAmB,EACpB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,OAAO,EACR,MAAM,sBAAsB,CAAC;AAE9B,cAAc;AACd,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAElC,YAAY;AACZ,cAAc,kBAAkB,CAAC"}

package/dist/metadata/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./metadata.sdk.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/metadata/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/metadata/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC"}

package/dist/metadata/index.js

@@ -0,0 +1,2 @@
+export * from "./metadata.sdk.js";
+//# sourceMappingURL=index.js.map

package/dist/metadata/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/metadata/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC"}

package/dist/metadata/metadata.sdk.d.ts

@@ -0,0 +1,111 @@
+import { AssetConfigDto, Dataset, DatasetDto, DatasetManagementStateDto, DatasetStateUpdateDto, DatasetSubmissionResponseDto } from "@tsg-dsp/common-dsp";
+import type { VersionedRef } from "../vendor/common-dtos/index.js";
+import type { ControlPlaneClient } from "../client.js";
+/**
+ * Input for publishing or updating a dataset.
+ *
+ * Mirrors the control plane `DatasetSubmissionDto`: public DCAT-AP metadata is
+ * published to the catalog while the private {@link AssetConfigDto | asset
+ * configuration} (backend URL + authorization) is stored privately and never
+ * exposed through the catalog. It is forwarded to the serving data plane only
+ * at dataflow `prepare` time.
+ */
+export interface DatasetSubmission {
+    /** Identifier of the data plane that will serve the dataset. */
+    dataPlaneId: string;
+    /**
+     * DCAT-AP dataset metadata, either as a {@link Dataset} class instance or an
+     * already-serialized JSON-LD {@link DatasetDto}.
+     */
+    dataset: Dataset | DatasetDto;
+    /**
+     * Private execution configuration withheld from the public catalog.
+     * Omission during update clears the previous configuration.
+     */
+    assetConfig?: AssetConfigDto;
+    /** Immutable consumer credential requirements referenced by the ODRL offer. */
+    requirementSetRef?: VersionedRef;
+}
+/**
+ * Publish and manage datasets through the control plane management API.
+ *
+ * The metadata module decouples dataset creation from the data plane: an
+ * application decides *what* datasets exist — their DCAT-AP metadata, ODRL
+ * policies and backend configuration — and submits them to the control plane,
+ * which records which data plane serves each dataset. The data plane itself
+ * only receives execution configuration just-in-time during a transfer.
+ * @example
+ * ```ts
+ * const { datasetId } = await sdk.metadata.publishDataset({
+ *   dataPlaneId: "urn:uuid:dp-1",
+ *   dataset: new Dataset({ id: "urn:uuid:ds-1", title: ["Sales"] }),
+ *   assetConfig: {
+ *     backendUrl: "http://backend.internal/api",
+ *     authorization: "Bearer secret",
+ *   },
+ * });
+ * ```
+ */
+export declare class MetadataSdk {
+    private readonly client;
+    constructor(client: ControlPlaneClient);
+    /**
+     * Build the request body, serializing the dataset to a JSON-LD DTO when a
+     * {@link Dataset} class instance is supplied and passing through an
+     * already-serialized DTO unchanged.
+     * @param submission - The dataset submission input.
+     * @returns The request body shaped for the generated client.
+     * @internal
+     */
+    private toBody;
+    /**
+     * Publish a new dataset: submit its DCAT metadata plus private asset
+     * configuration and record which data plane serves it.
+     * @param submission - The dataset metadata, serving data plane, and asset configuration.
+     * @returns The id assigned to the published dataset.
+     * @throws Throws an {@link SdkError} with code {@link SdkErrorCode.REQUEST_FAILED} if the submission is rejected.
+     */
+    publishDataset(submission: DatasetSubmission): Promise<DatasetSubmissionResponseDto>;
+    /**
+     * Update an existing dataset's metadata and asset configuration.
+     * @param id - The dataset identifier.
+     * @param submission - The updated dataset metadata, serving data plane, and asset configuration.
+     * @returns The id of the updated dataset.
+     * @throws Throws an {@link SdkError} with code {@link SdkErrorCode.NOT_FOUND} if the dataset does not exist.
+     */
+    updateDataset(id: string, submission: DatasetSubmission): Promise<DatasetSubmissionResponseDto>;
+    /**
+     * Update public metadata without replacing private backend configuration,
+     * the owning data plane or credential requirements. Existing dataflows keep
+     * their prepare-time configuration, including after explicit replacements.
+     * @param id - The existing dataset identifier.
+     * @param dataset - The complete updated public metadata.
+     * @returns The updated public dataset.
+     */
+    updateDatasetMetadata(id: string, dataset: Dataset | DatasetDto): Promise<DatasetDto>;
+    /**
+     * Remove a dataset from the catalog and delete its stored asset configuration.
+     * @param id - The dataset identifier.
+     * @throws Throws an {@link SdkError} with code {@link SdkErrorCode.NOT_FOUND} if the dataset does not exist.
+     */
+    removeDataset(id: string): Promise<void>;
+    /**
+     * List all published datasets.
+     * @param returnDto - When `true`, returns raw JSON-LD {@link DatasetDto} objects instead of deserialized {@link Dataset} instances.
+     * @returns The published datasets.
+     */
+    listDatasets(returnDto: true): Promise<DatasetDto[]>;
+    listDatasets(returnDto?: false): Promise<Dataset[]>;
+    /**
+     * Fetch a single published dataset by id.
+     * @param id - The dataset identifier.
+     * @param returnDto - When `true`, returns the raw JSON-LD {@link DatasetDto} instead of a deserialized {@link Dataset} instance.
+     * @returns The requested dataset.
+     * @throws Throws an {@link SdkError} with code {@link SdkErrorCode.NOT_FOUND} if the dataset does not exist.
+     */
+    getDataset(id: string, returnDto: true): Promise<DatasetDto>;
+    getDataset(id: string, returnDto?: false): Promise<Dataset>;
+    getDatasetState(id: string): Promise<DatasetManagementStateDto>;
+    updateDatasetState(id: string, update: DatasetStateUpdateDto): Promise<DatasetManagementStateDto>;
+}
+//# sourceMappingURL=metadata.sdk.d.ts.map

package/dist/metadata/metadata.sdk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.sdk.d.ts","sourceRoot":"","sources":["../../src/metadata/metadata.sdk.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,OAAO,EACP,UAAU,EACV,yBAAyB,EACzB,qBAAqB,EACrB,4BAA4B,EAC7B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAGzD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAavD;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAiB;IAChC,gEAAgE;IAChE,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,OAAO,EAAE,OAAO,GAAG,UAAU,CAAC;IAC9B;;;OAGG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC;IAC7B,+EAA+E;IAC/E,iBAAiB,CAAC,EAAE,YAAY,CAAC;CAClC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,WAAW;IACV,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,kBAAkB;IAEvD;;;;;;;OAOG;IACH,OAAO,CAAC,MAAM;IAcd;;;;;;OAMG;IACG,cAAc,CAClB,UAAU,EAAE,iBAAiB,GAC5B,OAAO,CAAC,4BAA4B,CAAC;IAaxC;;;;;;OAMG;IACG,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,iBAAiB,GAC5B,OAAO,CAAC,4BAA4B,CAAC;IAcxC;;;;;;;OAOG;IACG,qBAAqB,CACzB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,OAAO,GAAG,UAAU,GAC5B,OAAO,CAAC,UAAU,CAAC;IAetB;;;;OAIG;IACG,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM9C;;;;OAIG;IACG,YAAY,CAAC,SAAS,EAAE,IAAI,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IACpD,YAAY,CAAC,SAAS,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IASzD;;;;;;OAMG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,GAAG,OAAO,CAAC,UAAU,CAAC;IAC5D,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC;IAQ3D,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAa/D,kBAAkB,CACtB,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,yBAAyB,CAAC;CAatC"}

package/dist/metadata/metadata.sdk.js

@@ -0,0 +1,142 @@
+import { Dataset } from "@tsg-dsp/common-dsp";
+import { SdkError, SdkErrorCode } from "../utils/errors.js";
+import { validateJsonLD } from "../utils/validate.js";
+/**
+ * Publish and manage datasets through the control plane management API.
+ *
+ * The metadata module decouples dataset creation from the data plane: an
+ * application decides *what* datasets exist — their DCAT-AP metadata, ODRL
+ * policies and backend configuration — and submits them to the control plane,
+ * which records which data plane serves each dataset. The data plane itself
+ * only receives execution configuration just-in-time during a transfer.
+ * @example
+ * ```ts
+ * const { datasetId } = await sdk.metadata.publishDataset({
+ *   dataPlaneId: "urn:uuid:dp-1",
+ *   dataset: new Dataset({ id: "urn:uuid:ds-1", title: ["Sales"] }),
+ *   assetConfig: {
+ *     backendUrl: "http://backend.internal/api",
+ *     authorization: "Bearer secret",
+ *   },
+ * });
+ * ```
+ */
+export class MetadataSdk {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Build the request body, serializing the dataset to a JSON-LD DTO when a
+     * {@link Dataset} class instance is supplied and passing through an
+     * already-serialized DTO unchanged.
+     * @param submission - The dataset submission input.
+     * @returns The request body shaped for the generated client.
+     * @internal
+     */
+    toBody(submission) {
+        const dataset = submission.dataset instanceof Dataset
+            ? submission.dataset.serialize()
+            : submission.dataset;
+        return {
+            dataPlaneId: submission.dataPlaneId,
+            // Cast to bridge the strict generated schema vs. the JSON-LD DatasetDto.
+            dataset: dataset,
+            assetConfig: submission.assetConfig,
+            requirementSetRef: submission.requirementSetRef
+        };
+    }
+    /**
+     * Publish a new dataset: submit its DCAT metadata plus private asset
+     * configuration and record which data plane serves it.
+     * @param submission - The dataset metadata, serving data plane, and asset configuration.
+     * @returns The id assigned to the published dataset.
+     * @throws Throws an {@link SdkError} with code {@link SdkErrorCode.REQUEST_FAILED} if the submission is rejected.
+     */
+    async publishDataset(submission) {
+        const { data } = await this.client.POST("/management/datasets", {
+            body: this.toBody(submission)
+        });
+        if (!data) {
+            throw new SdkError("Dataset submission returned no response body", SdkErrorCode.REQUEST_FAILED);
+        }
+        return data;
+    }
+    /**
+     * Update an existing dataset's metadata and asset configuration.
+     * @param id - The dataset identifier.
+     * @param submission - The updated dataset metadata, serving data plane, and asset configuration.
+     * @returns The id of the updated dataset.
+     * @throws Throws an {@link SdkError} with code {@link SdkErrorCode.NOT_FOUND} if the dataset does not exist.
+     */
+    async updateDataset(id, submission) {
+        const { data } = await this.client.PUT("/management/datasets/{id}", {
+            params: { path: { id } },
+            body: this.toBody(submission)
+        });
+        if (!data) {
+            throw new SdkError("Dataset update returned no response body", SdkErrorCode.REQUEST_FAILED);
+        }
+        return data;
+    }
+    /**
+     * Update public metadata without replacing private backend configuration,
+     * the owning data plane or credential requirements. Existing dataflows keep
+     * their prepare-time configuration, including after explicit replacements.
+     * @param id - The existing dataset identifier.
+     * @param dataset - The complete updated public metadata.
+     * @returns The updated public dataset.
+     */
+    async updateDatasetMetadata(id, dataset) {
+        const { data } = await this.client.PUT("/management/catalog/dataset/{id}", {
+            params: { path: { id } },
+            body: (dataset instanceof Dataset
+                ? dataset.serialize()
+                : dataset)
+        });
+        if (!data)
+            throw new SdkError("Dataset metadata update returned no response body", SdkErrorCode.REQUEST_FAILED);
+        return data;
+    }
+    /**
+     * Remove a dataset from the catalog and delete its stored asset configuration.
+     * @param id - The dataset identifier.
+     * @throws Throws an {@link SdkError} with code {@link SdkErrorCode.NOT_FOUND} if the dataset does not exist.
+     */
+    async removeDataset(id) {
+        await this.client.DELETE("/management/datasets/{id}", {
+            params: { path: { id } }
+        });
+    }
+    async listDatasets(returnDto = false) {
+        const { data } = await this.client.GET("/management/datasets");
+        const datasets = data ?? [];
+        return Promise.all(datasets.map((dataset) => validateJsonLD(dataset, returnDto)));
+    }
+    async getDataset(id, returnDto = false) {
+        const { data } = await this.client.GET("/management/datasets/{id}", {
+            params: { path: { id } }
+        });
+        return validateJsonLD(data, returnDto);
+    }
+    async getDatasetState(id) {
+        const { data } = await this.client.GET("/management/datasets/{id}/state", {
+            params: { path: { id } }
+        });
+        if (!data) {
+            throw new SdkError(`Dataset ${id} management state was not returned`, SdkErrorCode.NOT_FOUND);
+        }
+        return data;
+    }
+    async updateDatasetState(id, update) {
+        const { data } = await this.client.PUT("/management/datasets/{id}/state", {
+            params: { path: { id } },
+            body: update
+        });
+        if (!data) {
+            throw new SdkError(`Dataset ${id} management state update returned no body`, SdkErrorCode.REQUEST_FAILED);
+        }
+        return data;
+    }
+}
+//# sourceMappingURL=metadata.sdk.js.map

package/dist/metadata/metadata.sdk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.sdk.js","sourceRoot":"","sources":["../../src/metadata/metadata.sdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,OAAO,EAKR,MAAM,qBAAqB,CAAC;AAK7B,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAqCtD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,WAAW;IACO;IAA7B,YAA6B,MAA0B;QAA1B,WAAM,GAAN,MAAM,CAAoB;IAAG,CAAC;IAE3D;;;;;;;OAOG;IACK,MAAM,CAAC,UAA6B;QAC1C,MAAM,OAAO,GACX,UAAU,CAAC,OAAO,YAAY,OAAO;YACnC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,EAAE;YAChC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC;QACzB,OAAO;YACL,WAAW,EAAE,UAAU,CAAC,WAAW;YACnC,yEAAyE;YACzE,OAAO,EAAE,OAA2C;YACpD,WAAW,EAAE,UAAU,CAAC,WAAW;YACnC,iBAAiB,EAAE,UAAU,CAAC,iBAAiB;SACvB,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,cAAc,CAClB,UAA6B;QAE7B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,EAAE;YAC9D,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;SAC9B,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,QAAQ,CAChB,8CAA8C,EAC9C,YAAY,CAAC,cAAc,CAC5B,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,aAAa,CACjB,EAAU,EACV,UAA6B;QAE7B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,2BAA2B,EAAE;YAClE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE;YACxB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;SAC9B,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,QAAQ,CAChB,0CAA0C,EAC1C,YAAY,CAAC,cAAc,CAC5B,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,qBAAqB,CACzB,EAAU,EACV,OAA6B;QAE7B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,kCAAkC,EAAE;YACzE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE;YACxB,IAAI,EAAE,CAAC,OAAO,YAAY,OAAO;gBAC/B,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE;gBACrB,CAAC,CAAC,OAAO,CAAqC;SACjD,CAAC,CAAC;QACH,IAAI,CAAC,IAAI;YACP,MAAM,IAAI,QAAQ,CAChB,mDAAmD,EACnD,YAAY,CAAC,cAAc,CAC5B,CAAC;QACJ,OAAO,IAA6B,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAAC,EAAU;QAC5B,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,2BAA2B,EAAE;YACpD,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE;SACzB,CAAC,CAAC;IACL,CAAC;IASD,KAAK,CAAC,YAAY,CAAC,YAAqB,KAAK;QAC3C,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;QAC/D,MAAM,QAAQ,GAAG,IAAI,IAAI,EAAE,CAAC;QAC5B,OAAO,OAAO,CAAC,GAAG,CAChB,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,cAAc,CAAU,OAAO,EAAE,SAAS,CAAC,CAAC,CACvE,CAAC;IACJ,CAAC;IAWD,KAAK,CAAC,UAAU,CAAC,EAAU,EAAE,YAAqB,KAAK;QACrD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,2BAA2B,EAAE;YAClE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE;SACzB,CAAC,CAAC;QACH,OAAO,cAAc,CAAU,IAAI,EAAE,SAAS,CAAC,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,EAAU;QAC9B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,iCAAiC,EAAE;YACxE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE;SACzB,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,QAAQ,CAChB,WAAW,EAAE,oCAAoC,EACjD,YAAY,CAAC,SAAS,CACvB,CAAC;QACJ,CAAC;QACD,OAAO,IAAiC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,kBAAkB,CACtB,EAAU,EACV,MAA6B;QAE7B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,iCAAiC,EAAE;YACxE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE;YACxB,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,QAAQ,CAChB,WAAW,EAAE,2CAA2C,EACxD,YAAY,CAAC,cAAc,CAC5B,CAAC;QACJ,CAAC;QACD,OAAO,IAAiC,CAAC;IAC3C,CAAC;CACF"}

package/dist/negotiations/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./negotiations.sdk.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/negotiations/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/negotiations/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC"}

package/dist/negotiations/index.js

@@ -0,0 +1,2 @@
+export * from "./negotiations.sdk.js";
+//# sourceMappingURL=index.js.map

package/dist/negotiations/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/negotiations/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC"}