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

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 TNO Security Gateway / DAPS Backend
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,363 @@
-# Temporary Holding Version
+# @tsg-dsp/tsg-sdk
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+TypeScript SDK for interacting with TSG (TNO Security Gateway) Dataspace Protocol capabilities.
+
+## Installation
+
+Install the latest released SDK from npm:
+
+```bash
+npm install @tsg-dsp/tsg-sdk
+```
+
+Within this monorepo, use a workspace dependency to consume the current source:
+
+```bash
+pnpm --filter <consumer-package> add '@tsg-dsp/tsg-sdk@workspace:*'
+```
+
+For an interactive example against the current shared services, use the
+[managed SDK playground](../../sample/sdk/README.md).
+
+## Quick start
+
+Use URLs, audiences, canonical tenant ID, service-local slugs and workload
+credentials from your provisioned deployment. Values below illustrate the
+configuration shape; they are not seeded accounts or deployment defaults.
+The [module examples](samples/README.md) read these settings from environment
+variables and support an offline construction check.
+
+```typescript
+import { TsgSdk } from "@tsg-dsp/tsg-sdk";
+
+const sdk = TsgSdk.create({
+  controlPlaneBaseUrl: "http://localhost:3000",
+  walletBaseUrl: "http://localhost:3001",
+  ssoBridgeBaseUrl: "http://localhost:3002",
+  tenantSlug: "acme", // sent as X-Tenant-Slug on control-plane / wallet calls
+  canonicalTenantId: "11111111-1111-4111-8111-111111111111",
+  controlPlaneAudience: "control-plane-api",
+  walletAudience: "wallet-api",
+  auth: {
+    method: "client_secret_post",
+    clientId: controlPlaneClientId,
+    clientSecret: controlPlaneClientSecret
+  },
+  walletAuth: {
+    method: "client_secret_post",
+    clientId: walletClientId,
+    clientSecret: walletClientSecret
+  }
+});
+
+// Browse catalogs
+const catalog = await sdk.catalog.getOwnCatalog();
+const participants = await sdk.catalog.getRegistryAddresses();
+
+// Negotiate for a dataset
+const negotiation = await sdk.negotiations.requestNegotiation(
+  datasetId,
+  participantId,
+  remoteAddress,
+  offer
+);
+
+// Wait for agreement
+const finalized = await sdk.negotiations.waitForAgreement(negotiation.id);
+
+// Request a transfer
+const transfer = await sdk.transfers.requestTransfer(
+  agreementId,
+  participantId,
+  remoteAddress,
+  "https://w3id.org/dspace-sig/profile/http-pull"
+);
+```
+
+## Managed tenants
+
+`TenantManagementSdk` is a standalone client for the central manager. Use a
+human token issued for its audience. Workload provisioning credentials cannot
+administer organizations through these endpoints.
+
+```typescript
+import { AuthProvider, TenantManagementSdk } from "@tsg-dsp/tsg-sdk";
+
+const tenants = new TenantManagementSdk(
+  "https://hosted.example.com/tenant-management/api",
+  new AuthProvider(
+    { method: "access_token", accessToken: humanToken },
+    undefined
+  )
+);
+const accepted = await tenants.createForPlatform(
+  {
+    name: "Alice Corp",
+    slug: "alice-corp",
+    profile: "default",
+    owner: { kind: "new", username: "alice", email: "alice@example.com" }
+  },
+  "alice-corp-create-1"
+);
+const operation = await tenants.operation(accepted.operationId);
+```
+
+The client covers capabilities, account lookup/onboarding, setup links, operation
+history/retry, invitations, memberships, grants, ownership, lifecycle, audit and
+workload credential rotation. Self-service `create` requires explicit deployment
+policy. A setup link contains a URL only when email delivery is disabled.
+The browser export also provides `TenantManagementSdk`; omit its auth argument
+for same-origin cookie sessions.
+
+For managed Wallet/Control Plane calls, set `canonicalTenantId`,
+`controlPlaneAudience` and `walletAudience`. Keep the target-local tenant selector
+in `tenantSlug`, or use `controlPlaneTenantSlug` and `walletTenantSlug` when
+imported services have different URL names. `walletAuth` supplies a separate
+Wallet token or credential whenever explicit Control Plane authentication is configured. Tokens are never inherited across services. Setting `ssoBridgeBaseUrl` allows
+workload token discovery; it does not give `sdk.sso` management authority.
+Use `ssoAuth` and `ssoAudience` for a separate credential authorized to administer
+SSO. Tenant Management administration and consumer authorization use separate
+audiences. A tenant slug selects a service-local tenant; it does not replace the
+canonical tenant UUID in workload token requests. There is no implicit `default`
+tenant, seeded workload client, or token audience fallback.
+
+## Modules
+
+The SDK is organized into focused modules, each accessible as a property on the `TsgSdk` instance:
+
+### `sdk.catalog` — Catalog & Registry
+
+Browse catalogs, discover participants, and search datasets.
+
+| Method                                         | Description                                |
+| ---------------------------------------------- | ------------------------------------------ |
+| `getOwnCatalog()`                              | Get the local participant's catalog        |
+| `getParticipantCatalog(participantId)`         | Get a remote participant's catalog         |
+| `getRegistryAddresses()`                       | Get all known participant addresses        |
+| `getRegistryCatalogs()`                        | Get all catalogs from the registry         |
+| `getDidDocuments()`                            | Get DID documents from the registry        |
+| `refreshRegistry()`                            | Refresh the registry to discover new peers |
+| `getDataplanes()`                              | List configured data planes                |
+| `getDataset(id, audience, address)`            | Get a specific dataset                     |
+| `getDatasetConformingTo(conformsTo, audience)` | Find a dataset by conformance URI          |
+
+### `sdk.negotiations` — Contract Negotiations
+
+Manage the full negotiation lifecycle.
+
+| Method                                              | Description                    |
+| --------------------------------------------------- | ------------------------------ |
+| `listNegotiations()`                                | List all negotiations          |
+| `getNegotiation(processId)`                         | Get negotiation details        |
+| `getAgreement(agreementId)`                         | Get an agreement               |
+| `getNegotiationsForDataset(datasetId)`              | Get negotiations for a dataset |
+| `requestNegotiation(datasetId, participantId, ...)` | Request a new negotiation      |
+| `terminateNegotiation(processId, code, reason)`     | Terminate a negotiation        |
+| `waitForState(processId, targetState)`              | Poll until target state        |
+| `waitForAgreement(processId)`                       | Poll until FINALIZED           |
+| `negotiateAndWait(datasetId, participantId, ...)`   | Request + wait for agreement   |
+
+### `sdk.transfers` — Data Transfers
+
+Manage the full transfer lifecycle.
+
+| Method                                                     | Description                    |
+| ---------------------------------------------------------- | ------------------------------ |
+| `listTransfers()`                                          | List all transfers             |
+| `requestTransfer(agreementId, participantId, ...)`         | Request a new transfer         |
+| `getTransfer(processId)`                                   | Get transfer details           |
+| `startTransfer(processId, dataAddress?)`                   | Start a transfer               |
+| `completeTransfer(processId)`                              | Complete a transfer            |
+| `terminateTransfer(processId, code?, reason?)`             | Terminate a transfer           |
+| `suspendTransfer(processId, reason?)`                      | Suspend a transfer             |
+| `waitForState(processId, targetState)`                     | Poll until target state        |
+| `waitForStart(processId)` / `waitForCompletion(processId)` | Poll until STARTED / COMPLETED |
+| `transferAndWaitForStart(agreementId, ...)`                | Request + wait for start       |
+
+### `sdk.wallet` — Wallet & Credentials
+
+Signing, credentials, keys, and DID management.
+
+| Method                           | Description                  |
+| -------------------------------- | ---------------------------- |
+| `signJwt(request)`               | Request a JWT signature      |
+| `validateJwt(request)`           | Validate a JWT               |
+| `listCredentials()`              | List all credentials         |
+| `getCredential(credentialId)`    | Get a specific credential    |
+| `deleteCredential(credentialId)` | Delete a credential          |
+| `revokeCredential(credentialId)` | Revoke a credential          |
+| `getCredentialConfig()`          | Get credential configuration |
+| `listDataspaceCredentials()`     | List dataspace credentials   |
+| `getDidDocument()`               | Get the DID document         |
+| `getDidServices()`               | Get registered DID services  |
+| `listKeys()`                     | List all keys                |
+| `getKey(keyId)`                  | Get a specific key           |
+| `deleteKey(keyId)`               | Delete a key                 |
+| `setDefaultKey(keyId)`           | Set the default key          |
+| `createOffer(request)`           | Create a credential offer    |
+| `requestOfferViaDcp(request)`    | Request offer via DCP        |
+| `getOffer(id)`                   | Get a credential offer       |
+| `revokeOffer(id)`                | Revoke a credential offer    |
+
+### `sdk.sso` — SSO Bridge
+
+Token management, OpenID Connect, and user/client management.
+
+| Method                                       | Description                    |
+| -------------------------------------------- | ------------------------------ |
+| `getAccessToken()`                           | Get an access token            |
+| `getOpenIdConfiguration()`                   | Get OpenID configuration       |
+| `getJwks()`                                  | Get the JWKS                   |
+| `exchangeAuthorizationCode(code, ...)`       | Exchange an authorization code |
+| `refreshAccessToken(refreshToken, clientId)` | Refresh an access token        |
+| `management.getUsers()`                      | List users                     |
+| `management.createUser(user)`                | Create a user                  |
+| `management.updateUser(id, user)`            | Update a user                  |
+| `management.deleteUser(id)`                  | Delete a user                  |
+| `management.getClients()`                    | List OAuth clients             |
+| `management.createClient(client)`            | Create a client                |
+| `management.updateClient(id, client)`        | Update a client                |
+| `management.deleteClient(id)`                | Delete a client                |
+| `management.getPermissions()`                | List permissions               |
+
+## Authentication
+
+The SDK supports three authentication methods:
+
+### Client Secret (M2M)
+
+```typescript
+const sdk = TsgSdk.create({
+  controlPlaneBaseUrl: "http://localhost:3000",
+  ssoBridgeBaseUrl: "http://localhost:3002",
+  canonicalTenantId,
+  controlPlaneTenantSlug,
+  controlPlaneAudience,
+  auth: {
+    method: "client_secret_post",
+    clientId: controlPlaneClientId,
+    clientSecret: controlPlaneClientSecret
+  }
+});
+```
+
+### Private Key JWT (M2M)
+
+```typescript
+const sdk = TsgSdk.create({
+  controlPlaneBaseUrl: "http://localhost:3000",
+  ssoBridgeBaseUrl: "http://localhost:3002",
+  canonicalTenantId,
+  controlPlaneTenantSlug,
+  controlPlaneAudience,
+  auth: {
+    method: "private_key_jwt",
+    clientId: controlPlaneClientId,
+    privateKeyJwk: controlPlanePrivateKey
+  }
+});
+```
+
+### Pre-obtained access token
+
+Use a token issued for the receiving service and intended tenant. The SDK does
+not change its claims or refresh it. Configure `walletAuth` and `ssoAuth` with
+separate tokens when calling those services.
+
+```typescript
+const sdk = TsgSdk.create({
+  controlPlaneBaseUrl: "http://localhost:3000",
+  controlPlaneTenantSlug,
+  auth: {
+    method: "access_token",
+    accessToken: controlPlaneToken
+  }
+});
+```
+
+### Cookie sessions
+
+Omitting auth sends no bearer token. It does not bypass service authorization or
+select a tenant. In a same-origin browser session, configure the service-local
+tenant slug explicitly and let the browser send its existing session cookie.
+The Node.js module examples use explicit workload credentials instead.
+
+## Optional Modules
+
+The `wallet` and `sso` modules are optional. If their base URLs are not provided, accessing their methods will throw a `NOT_CONFIGURED` error with a helpful message:
+
+```typescript
+const sdk = TsgSdk.create({
+  controlPlaneBaseUrl: "http://localhost:3000"
+});
+
+// This will throw: "wallet module is not configured. Provide 'walletBaseUrl' in TsgSdkConfig."
+await sdk.wallet.signJwt(request);
+```
+
+## Error Handling
+
+All SDK errors are instances of `SdkError` with a typed `code` property:
+
+```typescript
+import { SdkError, SdkErrorCode } from "@tsg-dsp/tsg-sdk";
+
+try {
+  await sdk.catalog.getParticipantCatalog("unknown-participant");
+} catch (error) {
+  if (error instanceof SdkError) {
+    switch (error.code) {
+      case SdkErrorCode.NOT_FOUND:
+        console.log("Participant not found");
+        break;
+      case SdkErrorCode.AUTH_FAILED:
+        console.log("Authentication failed");
+        break;
+      case SdkErrorCode.POLLING_TIMEOUT:
+        console.log("Operation timed out");
+        break;
+    }
+  }
+}
+```
+
+## Polling
+
+Methods that wait for state changes (`waitForAgreement`, `waitForStart`, etc.) accept polling options:
+
+```typescript
+await sdk.negotiations.waitForAgreement("process-id", {
+  intervalMs: 2000, // Poll every 2 seconds (default: 1000)
+  maxRetries: 30 // Max attempts (default: 20)
+});
+```
+
+## License
+
+Apache-2.0
+
+### External packaging
+
+The SDK build includes compiled private DTOs and their declarations under
+`dist/vendor`, plus generated OpenAPI types. Packaging preserves decorator
+metadata by copying the TypeScript compiler output. Only `common-dsp` remains a
+separately published TSG dependency. The browser entry does not load the DTOs.
+
+To check an external installation locally, build with
+`pnpm --filter @tsg-dsp/tsg-sdk... -r build`, pack with
+`pnpm --filter @tsg-dsp/tsg-sdk pack`, install the tarball outside the workspace,
+and compile a TypeScript consumer using both the main and browser entries.
+
+### Renewable HTTP data access
+
+Use `transfers.dataAccess(transferId)` before sending an HTTP data request. The
+control plane coordinates refresh-token rotation across clients and persists the
+new credentials. The returned object contains `endpoint` and `headers`.
+
+```ts
+const access = await sdk.transfers.dataAccess(transferId);
+const response = await fetch(access.endpoint, { headers: access.headers });
+```
+
+After a 401, request `{ forceRefresh: true }` and decide whether to repeat the
+request. The SDK never retries data requests automatically.