@settlemint/dalp-sdk 2.1.7-main.22780180229

package/LICENSE

@@ -0,0 +1,162 @@
+# SETTLEMINT COMMERCIAL CUSTOMER SOURCE LICENSE
+
+**("License")**
+
+---
+
+## TL;DR (NON-BINDING SUMMARY)
+
+- You may view, fork, modify, and run this code ONLY while you have an active, paid contract with SettleMint.
+- You may use it internally (cloud, on-prem, or hybrid) only as agreed in your contract.
+- You may NOT resell it, offer it as a service, publish it, or use it to build or operate a competing product.
+- When your contract ends, your right to use the software ends immediately. You must stop all deployments and delete active copies.
+- This is NOT open source.
+
+*This summary is informational only. The legal terms below control.*
+
+---
+
+Copyright © 2025 SettleMint NV
+All rights reserved.
+
+This License governs the use of the Software (as defined below) and is a proprietary, source-available license. It is not an open-source license.
+
+By accessing, copying, modifying, or using the Software, You agree to be bound by this License and confirm that You are a Customer with an Active Contract.
+
+---
+
+## 1. DEFINITIONS
+
+**1.1 "Licensor"**
+SettleMint NV, a company incorporated under Belgian law, or any affiliated entity explicitly identified in the applicable Commercial Agreement.
+
+**1.2 "Customer" or "You"**
+The legal entity that has entered into an Active Contract with Licensor and whose employees or contractors access or use the Software.
+
+**1.3 "Commercial Agreement"**
+Any master services agreement, subscription agreement, order form, statement of work, or similar contract executed between Licensor and Customer governing commercial terms.
+
+**1.4 "Active Contract"**
+A Commercial Agreement that is in force, not terminated, and for which all undisputed fees due are paid.
+
+**1.5 "Software"**
+The source code, object code, build scripts, configuration files, documentation, and any other materials made available by Licensor in this repository, including all updates and modifications thereto.
+
+**1.6 "Derivative Works"**
+Any modification, adaptation, translation, or other work based on or incorporating the Software, as defined under Book XI of the Belgian Code of Economic Law.
+
+**1.7 "Authorized Use"**
+Use of the Software solely for Customer's internal business purposes and strictly within the scope permitted by the Active Contract.
+
+**1.8 "Authorized Deployment"**
+Any installation, environment, system, blockchain network, cluster, or runtime explicitly permitted under the Active Contract, whether cloud-based, on-premises, or hybrid.
+
+**1.9 "Competitive Use"**
+Any use of the Software or Derivative Works to develop, operate, market, or support a product or service that competes with Licensor's products or services, or that could reasonably substitute for them.
+
+---
+
+## 2. LICENSE GRANT
+
+**2.1 Conditional License Grant**
+Subject to continuous compliance with this License and the existence of an Active Contract, Licensor grants Customer a limited, non-exclusive, non-transferable, non-sublicensable, revocable license to:
+
+(a) access and review the Software;
+(b) copy the Software for internal use;
+(c) modify the Software and create Derivative Works;
+(d) deploy and run the Software and Derivative Works solely for Authorized Use and only in Authorized Deployments.
+
+**2.2 Forking**
+Customer may create private forks of the Software solely for Authorized Use. All such forks remain subject to this License.
+
+**2.3 No Implied Rights**
+No rights are granted except as expressly stated. All rights not expressly granted are reserved by Licensor.
+
+---
+
+## 3. RESTRICTIONS
+
+Customer shall not, directly or indirectly:
+
+(a) use the Software without an Active Contract;
+(b) deploy the Software outside Authorized Deployments;
+(c) provide the Software or any Derivative Work as a service, platform, or product to third parties, unless explicitly permitted in writing;
+(d) sublicense, distribute, sell, lease, or transfer the Software or any Derivative Work to any third party;
+(e) engage in any Competitive Use;
+(f) use the Software to benchmark, reverse-engineer, or analyze Licensor's products for competitive purposes;
+(g) publish, disclose, or make publicly available the Software or any fork thereof;
+(h) remove or obscure copyright, trademark, or proprietary notices.
+
+---
+
+## 4. OWNERSHIP
+
+**4.1 Licensor IP**
+Licensor retains all right, title, and interest in and to the Software.
+
+**4.2 Customer Modifications**
+Customer retains ownership of original modifications it creates; however, Customer may not use, execute, deploy, or distribute any Derivative Work that includes or depends on the Software except as permitted under an Active Contract.
+
+**4.3 Feedback and Contributions**
+Any feedback, suggestions, or contributions provided by Customer may be used by Licensor without restriction. To the extent such contributions constitute copyrightable works, Customer grants Licensor a perpetual, worldwide, royalty-free, irrevocable license to use, modify, and distribute them.
+
+---
+
+## 5. TERMINATION
+
+**5.1 Automatic Termination**
+This License automatically terminates upon termination or expiration of the Active Contract.
+
+**5.2 Effect of Termination**
+Upon termination, Customer must immediately:
+
+(a) cease all use and deployment of the Software and Derivative Works;
+(b) delete all running instances, binaries, containers, and deployments;
+(c) destroy or delete all copies of the Software, except that one archival copy of source code may be retained solely for legal or compliance purposes.
+
+No right to resume use or deployment survives termination.
+
+**5.3 Survival**
+Sections relating to ownership, restrictions, liability, governing law, and jurisdiction survive termination.
+
+---
+
+## 6. WARRANTY DISCLAIMER
+
+THE SOFTWARE IS PROVIDED "AS IS". TO THE MAXIMUM EXTENT PERMITTED BY BELGIAN LAW, LICENSOR DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
+
+---
+
+## 7. LIMITATION OF LIABILITY
+
+To the maximum extent permitted by Belgian law, Licensor shall not be liable for any indirect, incidental, consequential, or special damages, including loss of profits, data, or business interruption, even if advised of the possibility.
+
+Nothing in this License limits liability that cannot be limited under mandatory Belgian law.
+
+---
+
+## 8. GOVERNING LAW AND JURISDICTION
+
+This License is governed by and construed in accordance with the laws of Belgium, excluding conflict-of-law rules.
+
+Any dispute arising out of or in connection with this License shall be subject to the exclusive jurisdiction of the courts of Brussels.
+
+---
+
+## 9. MISCELLANEOUS
+
+**9.1 Entire Agreement**
+This License, together with the applicable Commercial Agreement, constitutes the entire agreement regarding the Software.
+
+**9.2 Conflict**
+In case of conflict, the Commercial Agreement prevails.
+
+**9.3 Severability**
+If any provision is held invalid, the remaining provisions remain in full force.
+
+**9.4 No Waiver**
+Failure to enforce any provision does not constitute a waiver.
+
+---
+
+**END OF LICENSE**

package/README.md

@@ -0,0 +1,116 @@
+<p align="center">
+  <img src="https://github.com/settlemint/sdk/blob/main/logo.svg" width="200px" align="center" alt="SettleMint logo" />
+  <h1 align="center">DALP SDK</h1>
+  <p align="center">
+    <a href="https://settlemint.com">https://settlemint.com</a>
+    <br/>
+    Fully typed TypeScript SDK for the Digital Asset Lifecycle Platform API.
+  </p>
+</p>
+
+<p align="center">
+<a href="https://www.npmjs.com/package/@settlemint/dalp-sdk" rel="nofollow"><img src="https://img.shields.io/npm/v/@settlemint/dalp-sdk" alt="npm version"></a>
+<a href="https://www.npmjs.com/package/@settlemint/dalp-sdk" rel="nofollow"><img src="https://img.shields.io/npm/dw/@settlemint/dalp-sdk" alt="npm downloads"></a>
+</p>
+
+<div align="center">
+  <a href="https://settlemint.com">Website</a>
+  <span>&nbsp;&nbsp;&bull;&nbsp;&nbsp;</span>
+  <a href="https://www.npmjs.com/package/@settlemint/dalp-sdk">NPM</a>
+  <span>&nbsp;&nbsp;&bull;&nbsp;&nbsp;</span>
+  <a href="mailto:support@settlemint.com">Support</a>
+  <br />
+</div>
+
+## About
+
+The DALP SDK provides a fully typed client for the Digital Asset Lifecycle Platform API. Built on [oRPC](https://orpc.unnoq.com/) with contract-first types, it gives you auto-complete for every API namespace — tokens, identities, compliance, transactions, and more.
+
+## Installation
+
+```bash
+# npm
+npm install @settlemint/dalp-sdk
+
+# bun
+bun add @settlemint/dalp-sdk
+```
+
+## Quick Start
+
+```typescript
+import { createDalpClient } from "@settlemint/dalp-sdk";
+
+const dalp = createDalpClient({
+  url: "https://dalp.example.com",
+  apiKey: "sm_dalp_...",
+  organizationId: "org_...", // optional, for multi-org setups
+});
+
+// Every method is fully typed with auto-complete
+const tokens = await dalp.token.list({ query: {} });
+const system = await dalp.system.read({});
+```
+
+## Configuration
+
+```typescript
+import { createDalpClient } from "@settlemint/dalp-sdk";
+
+const dalp = createDalpClient({
+  // Required
+  url: "https://dalp.example.com",
+  apiKey: "sm_dalp_...",
+
+  // Optional
+  organizationId: "org_...", // multi-org scoping
+  headers: { "User-Agent": "MyApp" }, // override default headers
+  idempotencyKey: "req_abc123", // ⚠️ sent on EVERY request — use only for single-mutation clients
+  requestValidation: true, // validate requests client-side (default: true)
+  responseValidation: false, // validate responses client-side (default: false)
+  fetch: customFetch, // custom fetch implementation
+});
+```
+
+## API Namespaces
+
+| Namespace          | Description                |
+| ------------------ | -------------------------- |
+| `account`          | Manage accounts            |
+| `actions`          | Manage actions             |
+| `addons`           | Manage addons              |
+| `admin`            | Administrative operations  |
+| `contacts`         | Manage contacts            |
+| `exchangeRates`    | View exchange rates        |
+| `externalToken`    | Manage external tokens     |
+| `identityRecovery` | Recover lost identities    |
+| `monitoring`       | Platform monitoring        |
+| `search`           | Search across the platform |
+| `settings`         | Platform settings          |
+| `system`           | System administration      |
+| `token`            | Manage security tokens     |
+| `transaction`      | View transactions          |
+| `user`             | Manage platform users      |
+
+## Subpath Exports
+
+```typescript
+// Main entry — client factory, error codes, serializers
+import { createDalpClient } from "@settlemint/dalp-sdk";
+
+// Type-only — for function signatures without runtime code
+import type { DalpClient, DalpClientConfig } from "@settlemint/dalp-sdk/types";
+
+// Plugins — optional oRPC link plugins for advanced usage
+import { BatchLinkPlugin, RequestValidationPlugin } from "@settlemint/dalp-sdk/plugins";
+```
+
+## Security
+
+- **API key authentication** — issued via the DALP dashboard (Settings → API Keys) or via `dalp login`
+- Security headers (`x-api-key`, `x-organization-id`) cannot be overridden by custom headers
+- Client-side request validation enabled by default to catch schema violations early
+
+## License
+
+This project is licensed under the **SettleMint Commercial Customer Source License**. See the LICENSE file included in the package for full terms.

package/dist/client.d.ts

@@ -0,0 +1,18 @@
+import type { DalpClient, DalpClientConfig } from "./types.js";
+/**
+ * Create a fully typed DALP API client.
+ *
+ * @example
+ * ```typescript
+ * import { createDalpClient } from "@settlemint/dalp-sdk";
+ *
+ * const dalp = createDalpClient({
+ *   url: "https://dalp.example.com",
+ *   apiKey: "sm_dalp_...",
+ *   organizationId: "org_...",
+ * });
+ *
+ * const tokens = await dalp.token.list({ query: {} });
+ * ```
+ */
+export declare function createDalpClient(config: DalpClientConfig): DalpClient;

package/dist/contract.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Re-exports the DALP v2 RPC contract.
+ *
+ * At build time, `bun build` bundles the contract definition (including all
+ * Zod schemas from workspace packages) into the SDK's `dist/` output.
+ * Consumers never need to install workspace-only packages.
+ *
+ * Related: packages/dalp/dapi/contract/src/contract.ts
+ *
+ * @module
+ */
+export { rpcContract } from "@dalp/dapi-contract";

package/dist/errors.d.ts

@@ -0,0 +1,45 @@
+/**
+ * DALP API error codes.
+ *
+ * Mirrored from the canonical contract definition so the SDK has zero
+ * runtime dependency on workspace-only packages.
+ *
+ * Related: packages/dalp/dapi/contract/src/errors.ts
+ *
+ * @module
+ */
+/** All error codes the DALP API may return. */
+export declare const CUSTOM_ERROR_CODES: {
+    /** User lacks the required on-chain role for this token operation. */
+    readonly USER_NOT_AUTHORIZED: "USER_NOT_AUTHORIZED";
+    /** Authenticated but not authorized for this operation. */
+    readonly FORBIDDEN: "FORBIDDEN";
+    /** Malformed request. */
+    readonly BAD_REQUEST: "BAD_REQUEST";
+    /** Request data failed Zod schema validation. */
+    readonly INPUT_VALIDATION_FAILED: "INPUT_VALIDATION_FAILED";
+    /** Token does not implement a required ERC interface. */
+    readonly TOKEN_INTERFACE_NOT_SUPPORTED: "TOKEN_INTERFACE_NOT_SUPPORTED";
+    /** Unexpected server-side error. */
+    readonly INTERNAL_SERVER_ERROR: "INTERNAL_SERVER_ERROR";
+    /** The Graph subgraph query failed. */
+    readonly THE_GRAPH_ERROR: "THE_GRAPH_ERROR";
+    /** Resource state conflict (e.g., duplicate creation). */
+    readonly CONFLICT: "CONFLICT";
+    /** DALP system bootstrap has not been completed. */
+    readonly SYSTEM_NOT_CREATED: "SYSTEM_NOT_CREATED";
+    /** Requested resource does not exist. */
+    readonly NOT_FOUND: "NOT_FOUND";
+    /** Resource already exists. */
+    readonly RESOURCE_ALREADY_EXISTS: "RESOURCE_ALREADY_EXISTS";
+    /** User has not completed onboarding. */
+    readonly NOT_ONBOARDED: "NOT_ONBOARDED";
+    /** Transaction confirmation exceeded timeout. */
+    readonly CONFIRMATION_TIMEOUT: "CONFIRMATION_TIMEOUT";
+    /** Authentication missing or expired. */
+    readonly UNAUTHORIZED: "UNAUTHORIZED";
+    /** Required addon is not installed on this deployment. */
+    readonly ADDON_NOT_INSTALLED: "ADDON_NOT_INSTALLED";
+};
+/** Union of all DALP API error code strings. */
+export type ErrorCode = keyof typeof CUSTOM_ERROR_CODES;

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * DALP SDK — fully typed client for the DALP tokenization platform API.
+ *
+ * @example
+ * ```typescript
+ * import { createDalpClient } from "@settlemint/dalp-sdk";
+ *
+ * const dalp = createDalpClient({
+ *   url: "https://dalp.example.com",
+ *   apiKey: "sm_dalp_...",
+ * });
+ *
+ * // All methods are fully typed with auto-complete
+ * const tokens = await dalp.token.list({ query: {} });
+ * const system = await dalp.system.read({});
+ * ```
+ *
+ * @module
+ */
+export { createDalpClient } from "./client.js";
+export type { DalpClient, DalpClientConfig } from "./types.js";
+export { CUSTOM_ERROR_CODES } from "./errors.js";
+export type { ErrorCode } from "./errors.js";
+export { bigDecimalSerializer, bigIntSerializer, dalpSerializers, timestampSerializer } from "./serializers.js";
+export { SDK_USER_AGENT, SDK_VERSION } from "./version.js";