@settlemint/sdk-js 1.0.5-main99d4b95b → 1.0.5-mainb935fa12

package/README.md

@@ -32,6 +32,7 @@
     - [createSettleMintClient()](#createsettlemintclient)
   - [Interfaces](#interfaces)
     - [SettlemintClient](#settlemintclient)
+    - [SettlemintClientOptions](#settlemintclientoptions)
   - [Type Aliases](#type-aliases)
     - [Application](#application)
     - [BlockchainNetwork](#blockchainnetwork)
@@ -60,7 +61,7 @@ The SettleMint JavaScript SDK provides a type-safe wrapper around the SettleMint
 
 > **createSettleMintClient**(`options`): [`SettlemintClient`](README.md#settlemintclient)
 
-Defined in: [sdk/js/src/settlemint.ts:201](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/settlemint.ts#L201)
+Defined in: [settlemint.ts:210](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/settlemint.ts#L210)
 
 Creates a SettleMint client with the provided options. The client provides methods to interact with
 various SettleMint resources like workspaces, applications, blockchain networks, blockchain nodes, middleware,
@@ -70,9 +71,7 @@ integration tools, storage, private keys, insights and custom deployments.
 
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
-| `options` | \{ `accessToken`: `string`; `instance`: `string`; \} | Configuration options for the client including access token and instance URL |
-| `options.accessToken` | `string` | The access token used to authenticate with the SettleMint platform |
-| `options.instance` | `string` | The URL of the SettleMint instance to connect to |
+| `options` | [`SettlemintClientOptions`](README.md#settlemintclientoptions) | Configuration options for the client including access token and instance URL |
 
 ##### Returns
 
@@ -109,17 +108,37 @@ const workspace = await client.workspace.read('workspace-unique-name');
 
 #### SettlemintClient
 
-Defined in: [sdk/js/src/settlemint.ts:101](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/settlemint.ts#L101)
+Defined in: [settlemint.ts:110](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/settlemint.ts#L110)
 
 Client interface for interacting with the SettleMint platform.
 
+***
+
+#### SettlemintClientOptions
+
+Defined in: [settlemint.ts:102](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/settlemint.ts#L102)
+
+Options for the Settlemint client.
+
+##### Extends
+
+- `ClientOptions`
+
+##### Properties
+
+| Property | Type | Default value | Description | Inherited from | Defined in |
+| ------ | ------ | ------ | ------ | ------ | ------ |
+| <a id="accesstoken"></a> `accessToken` | `string` | `AccessTokenSchema` | The access token used to authenticate with the SettleMint platform | `ClientOptions.accessToken` | [helpers/client-options.schema.ts:9](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/helpers/client-options.schema.ts#L9) |
+| <a id="anonymous"></a> `anonymous?` | `boolean` | `undefined` | Whether to allow anonymous access (no access token required) | - | [settlemint.ts:104](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/settlemint.ts#L104) |
+| <a id="instance"></a> `instance` | `string` | `UrlSchema` | The URL of the SettleMint instance to connect to | `ClientOptions.instance` | [helpers/client-options.schema.ts:11](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/helpers/client-options.schema.ts#L11) |
+
 ### Type Aliases
 
 #### Application
 
 > **Application**: `ResultOf`\<*typeof* `ApplicationFragment`\>
 
-Defined in: [sdk/js/src/graphql/application.ts:23](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/application.ts#L23)
+Defined in: [graphql/application.ts:23](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/application.ts#L23)
 
 Type representing an application entity.
 
@@ -129,7 +148,7 @@ Type representing an application entity.
 
 > **BlockchainNetwork**: `ResultOf`\<*typeof* `BlockchainNetworkFragment`\>
 
-Defined in: [sdk/js/src/graphql/blockchain-network.ts:29](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/blockchain-network.ts#L29)
+Defined in: [graphql/blockchain-network.ts:29](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/blockchain-network.ts#L29)
 
 Type representing a blockchain network entity.
 
@@ -139,7 +158,7 @@ Type representing a blockchain network entity.
 
 > **BlockchainNode**: `ResultOf`\<*typeof* `BlockchainNodeFragment`\>
 
-Defined in: [sdk/js/src/graphql/blockchain-node.ts:48](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/blockchain-node.ts#L48)
+Defined in: [graphql/blockchain-node.ts:48](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/blockchain-node.ts#L48)
 
 Type representing a blockchain node entity.
 
@@ -149,7 +168,7 @@ Type representing a blockchain node entity.
 
 > **CustomDeployment**: `ResultOf`\<*typeof* `CustomDeploymentFragment`\>
 
-Defined in: [sdk/js/src/graphql/custom-deployment.ts:30](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/custom-deployment.ts#L30)
+Defined in: [graphql/custom-deployment.ts:30](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/custom-deployment.ts#L30)
 
 Type representing a custom deployment entity.
 
@@ -159,7 +178,7 @@ Type representing a custom deployment entity.
 
 > **Insights**: `ResultOf`\<*typeof* `InsightsFragment`\>
 
-Defined in: [sdk/js/src/graphql/insights.ts:34](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/insights.ts#L34)
+Defined in: [graphql/insights.ts:34](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/insights.ts#L34)
 
 Type representing an insights entity.
 
@@ -169,7 +188,7 @@ Type representing an insights entity.
 
 > **IntegrationTool**: `ResultOf`\<*typeof* `IntegrationFragment`\>
 
-Defined in: [sdk/js/src/graphql/integration-tool.ts:32](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/integration-tool.ts#L32)
+Defined in: [graphql/integration-tool.ts:32](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/integration-tool.ts#L32)
 
 Type representing an integration tool entity.
 
@@ -179,7 +198,7 @@ Type representing an integration tool entity.
 
 > **Middleware**: `ResultOf`\<*typeof* `MiddlewareFragment`\>
 
-Defined in: [sdk/js/src/graphql/middleware.ts:40](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/middleware.ts#L40)
+Defined in: [graphql/middleware.ts:40](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/middleware.ts#L40)
 
 Type representing a middleware entity.
 
@@ -189,7 +208,7 @@ Type representing a middleware entity.
 
 > **MiddlewareWithSubgraphs**: `ResultOf`\<*typeof* `getGraphMiddlewareSubgraphs`\>\[`"middlewareByUniqueName"`\]
 
-Defined in: [sdk/js/src/graphql/middleware.ts:98](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/middleware.ts#L98)
+Defined in: [graphql/middleware.ts:98](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/middleware.ts#L98)
 
 Type representing a middleware entity with subgraphs.
 
@@ -199,7 +218,7 @@ Type representing a middleware entity with subgraphs.
 
 > **PlatformConfig**: `ResultOf`\<*typeof* `getPlatformConfigQuery`\>\[`"config"`\]
 
-Defined in: [sdk/js/src/graphql/platform.ts:44](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/platform.ts#L44)
+Defined in: [graphql/platform.ts:44](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/platform.ts#L44)
 
 Type representing the platform configuration.
 
@@ -209,7 +228,7 @@ Type representing the platform configuration.
 
 > **PrivateKey**: `ResultOf`\<*typeof* `PrivateKeyFragment`\>
 
-Defined in: [sdk/js/src/graphql/private-key.ts:24](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/private-key.ts#L24)
+Defined in: [graphql/private-key.ts:24](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/private-key.ts#L24)
 
 Type representing a private key entity.
 
@@ -219,7 +238,7 @@ Type representing a private key entity.
 
 > **Storage**: `ResultOf`\<*typeof* `StorageFragment`\>
 
-Defined in: [sdk/js/src/graphql/storage.ts:32](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/storage.ts#L32)
+Defined in: [graphql/storage.ts:32](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/storage.ts#L32)
 
 Type representing a storage entity.
 
@@ -229,7 +248,7 @@ Type representing a storage entity.
 
 > **Workspace**: `ResultOf`\<*typeof* `WorkspaceFragment`\>
 
-Defined in: [sdk/js/src/graphql/workspace.ts:26](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/workspace.ts#L26)
+Defined in: [graphql/workspace.ts:26](https://github.com/settlemint/sdk/blob/v1.0.5/sdk/js/src/graphql/workspace.ts#L26)
 
 Type representing a workspace entity.
 

package/dist/settlemint.cjs

@@ -27,6 +27,7 @@ var import_http = require("@settlemint/sdk-utils/http");
 var import_runtime = require("@settlemint/sdk-utils/runtime");
 var import_validation3 = require("@settlemint/sdk-utils/validation");
 var import_graphql_request = require("graphql-request");
+var import_zod2 = require("zod");
 
 // src/helpers/graphql.ts
 var import_gql = require("gql.tada");
@@ -1498,11 +1499,17 @@ var ClientOptionsSchema = import_zod.z.object({
 // src/settlemint.ts
 function createSettleMintClient(options) {
   (0, import_runtime.ensureServer)();
-  const validatedOptions = (0, import_validation3.validate)(ClientOptionsSchema, options);
+  const validatedOptions = options.anonymous ? (0, import_validation3.validate)(
+    import_zod2.z.object({
+      ...ClientOptionsSchema.shape,
+      accessToken: import_zod2.z.literal("")
+    }),
+    options
+  ) : (0, import_validation3.validate)(ClientOptionsSchema, options);
   const baseUrl = new URL(validatedOptions.instance).toString().replace(/\/$/, "");
   const gqlClient = new import_graphql_request.GraphQLClient(`${baseUrl}/api/graphql`, {
     headers: {
-      "x-auth-token": validatedOptions.accessToken
+      "x-auth-token": validatedOptions.accessToken ?? ""
     },
     fetch: async (input, init) => {
       const response = await (0, import_http.fetchWithRetry)(input, init);