@xkova/sdk 0.1.0-alpha.4 → 0.1.0-alpha.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -491,39 +491,11 @@ idempotency, and settlement. It links the public customer OpenAPI and expanded
491
491
  documentation. Installed declarations determine the methods available in your
492
492
  version; live documentation may describe a newer release.
493
493
 
494
- ## Writing checks for contributors
494
+ ## Contributing
495
495
 
496
- Use plain verbs, concrete examples, and comments that explain non-obvious
497
- decisions. Vary section length, remove repeated conclusions, and write each
498
- guide for its reader. Test failure and recovery cases alongside successful
499
- calls. Keep commits small and omit attribution or co-author trailers.
500
-
501
- The local pre-push hook checks both public SDKs before the existing test gates.
502
- It reads each pushed branch or tag's committed files, plus new commit messages
503
- that touch either package. Uncommitted edits cannot change that result. No
504
- build or network access is needed. Use the repository's pinned Node version,
505
- then install workspace dependencies with `pnpm install` to set up the hook.
506
-
507
- To check edits before committing:
508
-
509
- ```sh
510
- pnpm --filter @xkova/sdk writing:check
511
- ```
512
-
513
- The check covers package guides, examples, public source and generated types,
514
- and descriptive package metadata. It rejects stock wording, emoji, em dashes,
515
- attribution, internal decision narratives, and implementation-provider details.
516
- Describe installation, supported methods, inputs, results, and the steps an
517
- application developer needs. Do not turn release planning or maintainer
518
- conversations into package documentation. Standard license text, rule
519
- definitions, and negative test fixtures are checked separately.
520
-
521
- A pass is a mechanical check, not a judgment of authorship. Before pushing,
522
- reread the result for sentence rhythm, repeated structures, useful comments,
523
- accurate examples, and test quality. This gate does not scan historical file
524
- contents or replace secret scanning. It checks commit messages locally;
525
- review PR descriptions separately. Run `pnpm --filter @xkova/sdk writing:test`
526
- when changing the rules or hook.
496
+ Run `pnpm check` from the source repository root before committing. The
497
+ [contributor guide](https://github.com/XKOVA/typescript-sdk/blob/main/CONTRIBUTING.md)
498
+ covers generated files, local pre-push checks, writing rules, and packaging.
527
499
 
528
500
  ## License
529
501
 
@@ -4478,6 +4478,7 @@ export interface components {
4478
4478
  /** @enum {string} */
4479
4479
  purpose: "operator" | "service_account";
4480
4480
  safe_purpose: ("fund_vault" | "token_control" | "multi_purpose") | null;
4481
+ managed_safe_state: ("deploying" | "active" | "decommissioned") | null;
4481
4482
  address: string;
4482
4483
  label: string | null;
4483
4484
  managed_safe_id: components["schemas"]["ManagedSafeId"] | null;
@@ -56,6 +56,7 @@ export declare class TokenizationResource extends Resource {
56
56
  kind: "server_key" | "safe";
57
57
  purpose: "operator" | "service_account";
58
58
  safe_purpose: ("fund_vault" | "token_control" | "multi_purpose") | null;
59
+ managed_safe_state: ("deploying" | "active" | "decommissioned") | null;
59
60
  address: string;
60
61
  label: string | null;
61
62
  managed_safe_id: import("../generated/types.js").components["schemas"]["ManagedSafeId"] | null;
@@ -68,6 +69,7 @@ export declare class TokenizationResource extends Resource {
68
69
  kind: "server_key" | "safe";
69
70
  purpose: "operator" | "service_account";
70
71
  safe_purpose: ("fund_vault" | "token_control" | "multi_purpose") | null;
72
+ managed_safe_state: ("deploying" | "active" | "decommissioned") | null;
71
73
  address: string;
72
74
  label: string | null;
73
75
  managed_safe_id: import("../generated/types.js").components["schemas"]["ManagedSafeId"] | null;
@@ -82,6 +84,7 @@ export declare class TokenizationResource extends Resource {
82
84
  kind: "server_key" | "safe";
83
85
  purpose: "operator" | "service_account";
84
86
  safe_purpose: ("fund_vault" | "token_control" | "multi_purpose") | null;
87
+ managed_safe_state: ("deploying" | "active" | "decommissioned") | null;
85
88
  address: string;
86
89
  label: string | null;
87
90
  managed_safe_id: import("../generated/types.js").components["schemas"]["ManagedSafeId"] | null;
@@ -100,6 +103,7 @@ export declare class TokenizationResource extends Resource {
100
103
  kind: "server_key" | "safe";
101
104
  purpose: "operator" | "service_account";
102
105
  safe_purpose: ("fund_vault" | "token_control" | "multi_purpose") | null;
106
+ managed_safe_state: ("deploying" | "active" | "decommissioned") | null;
103
107
  address: string;
104
108
  label: string | null;
105
109
  managed_safe_id: import("../generated/types.js").components["schemas"]["ManagedSafeId"] | null;
package/llms.txt CHANGED
@@ -5,12 +5,12 @@ Use this package on a Node.js 22+ server. Read the installed declarations before
5
5
  ## Read first
6
6
 
7
7
  - [Package guide](README.md): installation, production signing, Hosted Auth, member sessions, durable stores, cancellation, errors, webhooks, and proof verification.
8
- - [Client declarations](dist/client.d.ts): exact resource properties and client options for this installed release.
9
- - [Customer API types](dist/generated/types.d.ts): exact request bodies, responses, parameters, and operation IDs. Import types through @xkova/sdk/types.
10
- - [Member BFF declarations](dist/member-bff.d.ts): authorization, session persistence, refresh, logout, action reviews, and human authorization.
11
- - [Member resources](dist/member-resources.d.ts): typed resources bound to the exact authenticated member.
8
+ - `dist/client.d.ts`: exact resource properties and client options for this installed release.
9
+ - `dist/generated/types.d.ts`: exact request bodies, responses, parameters, and operation IDs. Import types through @xkova/sdk/types.
10
+ - `dist/member-bff.d.ts`: authorization, session persistence, refresh, logout, action reviews, and human authorization.
11
+ - `dist/member-resources.d.ts`: typed resources bound to the exact authenticated member.
12
12
  - [Quickstart](https://docs.xkova.com/getting-started.html): sandbox access and first authenticated call.
13
- - [Customer OpenAPI](https://docs.xkova.com/data/openapi-customer.json): machine-readable customer contract for the current published documentation.
13
+ - [Customer OpenAPI](https://github.com/XKOVA/typescript-sdk/blob/main/schema/customer-api.json): customer contract in this source repository. Installed declarations determine your release’s exact request and response types.
14
14
  - [SDK guide](https://docs.xkova.com/sdk-overview.html): client and resource examples.
15
15
  - [Workflow guide](https://docs.xkova.com/sdk-workflows.html): supported workflow helpers.
16
16
  - [Member integration](https://docs.xkova.com/embedded-member.html): browser, BFF, identity, and signing boundaries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xkova/sdk",
3
- "version": "0.1.0-alpha.4",
3
+ "version": "0.1.0-alpha.5",
4
4
  "description": "TypeScript SDK for the XKOVA API.",
5
5
  "homepage": "https://docs.xkova.com",
6
6
  "repository": {