@parity/product-sdk 0.0.0-dev.312.0

package/dist/types-B5Zx4RNq.d.ts

@@ -0,0 +1,211 @@
+import { LogLevel } from '@parity/product-sdk-logger';
+import { ProductCloudStorageError, CloudStorageEnvironment } from '@parity/product-sdk-cloud-storage';
+import { Result } from '@parity/result';
+import { ChainClient } from '@parity/product-sdk-chain-client';
+import { P as PeopleUsernameChain } from './dotns-bswWAmR2.js';
+import { ChainDefinition, TypedApi, PolkadotClient } from 'polkadot-api';
+
+/**
+ * Core types for @parity/product-sdk
+ */
+
+/** Cloud Storage configuration options */
+interface CloudStorageConfig {
+    /** Cloud Storage environment to connect to */
+    environment: CloudStorageEnvironment;
+}
+/** Configuration for createApp */
+interface AppConfig {
+    /** Application name - used to derive product accounts and namespace storage */
+    name: string;
+    /** Log level for SDK operations (default: 'info') */
+    logLevel?: LogLevel;
+    /**
+     * Cloud Storage configuration.
+     * - Omit or pass config object to enable (default: { environment: "paseo" })
+     * - Pass `false` to disable cloud storage initialization
+     */
+    cloudStorage?: CloudStorageConfig | false;
+}
+/** Wallet API exposed by the SDK */
+interface WalletApi {
+    /** Connect to available wallet providers */
+    connect(): Promise<{
+        accounts: Account[];
+    }>;
+    /** Disconnect from wallet */
+    disconnect(): Promise<void>;
+    /** Get all available accounts */
+    getAccounts(): Account[];
+    /** Get currently selected account */
+    getSelectedAccount(): Account | null;
+    /** Select an account by address */
+    selectAccount(address: string): void;
+    /** Sign an arbitrary message */
+    signMessage(message: string | Uint8Array): Promise<Uint8Array>;
+    /**
+     * Sign a message with the account that owns a People / People Lite DotNS identity.
+     *
+     * Pass the People / Individuality chain descriptor used for username lookup.
+     * Pass `username` to choose a specific identity. When omitted, the SDK first
+     * asks the host for the user's primary DotNS name and signs with the account
+     * that owns that username.
+     */
+    signMessageWithDotNsIdentity(args: SignMessageWithDotNsIdentityArgs): Promise<DotNsIdentitySignature>;
+    /** Subscribe to account changes */
+    onAccountChange(callback: (account: Account | null) => void): () => void;
+    /** Get product-scoped account (container mode only) */
+    getProductAccount(): Account | null;
+    /** Get anonymous alias via Ring VRF (container mode only) */
+    getAnonymousAlias(): string | null;
+    /** Create Ring VRF proof (container mode only) */
+    createProof(message: Uint8Array): Promise<Uint8Array>;
+}
+/** Storage API exposed by the SDK */
+interface LocalStorageApi {
+    /** Get a value by key */
+    get(key: string): Promise<string | null>;
+    /** Set a value by key */
+    set(key: string, value: string): Promise<void>;
+    /** Get a JSON value by key */
+    getJSON<T = unknown>(key: string): Promise<T | null>;
+    /** Set a JSON value by key */
+    setJSON<T = unknown>(key: string, value: T): Promise<void>;
+    /** Remove a value by key */
+    remove(key: string): Promise<void>;
+    /** Clear all values */
+    clear(): Promise<void>;
+}
+/** Chain API exposed by the SDK */
+interface ChainApi {
+    /**
+     * Get a typed PAPI client for a chain.
+     *
+     * Connections are routed through the host provider. The chain must be
+     * connected first via {@link connect}.
+     *
+     * @param descriptor - PAPI chain descriptor (from @parity/product-sdk-descriptors or custom)
+     * @returns Typed API for the chain
+     * @throws If the chain is not connected
+     */
+    getClient<T extends ChainDefinition>(descriptor: T): TypedApi<T>;
+    /**
+     * Get the raw PolkadotClient for a chain.
+     *
+     * Use this for advanced APIs like `createContractRuntime` from `@parity/product-sdk-contracts`.
+     *
+     * @param descriptor - PAPI chain descriptor
+     * @returns Raw PolkadotClient instance
+     * @throws If the chain is not connected
+     */
+    getRawClient(descriptor: ChainDefinition): PolkadotClient;
+    /**
+     * Connect to one or more chains.
+     *
+     * Connections are routed through the host provider (container-only).
+     * Results are cached - calling with the same descriptors returns existing connections.
+     *
+     * @param chains - Record of named chain descriptors
+     * @returns Connected chain client with typed APIs
+     */
+    connect<T extends Record<string, ChainDefinition>>(chains: T): Promise<ChainClient<T>>;
+    /**
+     * Check if a chain is currently connected.
+     */
+    isConnected(descriptor: ChainDefinition): boolean;
+    /**
+     * Destroy all chain connections.
+     */
+    destroyAll(): void;
+}
+/** Cloud Storage API exposed by the SDK */
+interface CloudStorageApi {
+    /**
+     * Upload data to the Cloud.
+     *
+     * Requires a wallet to be connected and an account selected.
+     *
+     * @returns A {@link Result}: `ok(cid)` on success, or `err(ProductCloudStorageError)`
+     *   if the upload fails (no signer, network rejection, or no CID returned).
+     */
+    upload(data: string | Uint8Array): Promise<Result<string, ProductCloudStorageError>>;
+    /**
+     * Fetch data by CID.
+     *
+     * @returns A {@link Result}: `ok(bytes)` on success, or `err(ProductCloudStorageError)`.
+     */
+    fetch(cid: string): Promise<Result<Uint8Array, ProductCloudStorageError>>;
+    /**
+     * Compute the CID for data without uploading.
+     *
+     * Async because the underlying hash is computed via Web Crypto. Does not
+     * perform I/O, so it throws on invalid input rather than returning a Result.
+     */
+    computeCid(data: string | Uint8Array): Promise<string>;
+}
+/** The main App instance returned by createApp */
+interface App {
+    /** Wallet/signing operations */
+    wallet: WalletApi;
+    /** Local Key-value storage operations */
+    localStorage: LocalStorageApi;
+    /** Chain interaction operations */
+    chain: ChainApi;
+    /** Cloud Storage operations (null if disabled via config) */
+    cloudStorage: CloudStorageApi | null;
+    /** Get app configuration */
+    getAppInfo(): AppConfig;
+}
+/** Account information */
+interface Account {
+    /** Account address (SS58 format) */
+    address: string;
+    /** Account name/label (if available) */
+    name?: string;
+    /** Source of the account (host, dev signer, etc.) */
+    source: string;
+}
+/** Arguments for signing with a DotNS / People username identity. */
+interface SignMessageWithDotNsIdentityArgs {
+    /**
+     * PAPI descriptor for the People / Individuality chain that exposes
+     * `Resources.UsernameOwnerOf`.
+     *
+     * The SDK reuses an already-connected client when one matches this
+     * descriptor's genesis. For long-running apps, call
+     * `app.chain.connect({ ..., <name>: peopleChain })` once at startup so
+     * every subsequent `signMessageWithDotNsIdentity` call reuses the same
+     * chainHead subscription. When the chain isn't already connected, the
+     * SDK opens a transient connection for the lookup; that connection then
+     * lives in the chain-client cache for the rest of the process.
+     */
+    peopleChain: PeopleUsernameChain;
+    /**
+     * People / People Lite username to resolve before signing.
+     *
+     * If omitted, the SDK fetches the primary DotNS name associated with the
+     * connected user from the host identity API. Note: that fetch triggers a
+     * host identity-permission prompt, so callers who want to avoid the
+     * dialog on a likely-miss should resolve the username themselves first.
+     *
+     * The string is UTF-8 encoded and used as the storage key on
+     * `Resources.UsernameOwnerOf` exactly as supplied — no `.dot` suffix
+     * handling is applied. On paseo-individuality today usernames are
+     * stored as bare strings (e.g. `alice`, not `alice.dot`); pass the
+     * exact value the chain has registered.
+     */
+    username?: string;
+    /** Message to sign. Strings are UTF-8 encoded before signing. */
+    message: string | Uint8Array;
+}
+/** Signature produced for a DotNS / People username identity. */
+interface DotNsIdentitySignature {
+    /** Username used for the lookup. */
+    username: string;
+    /** Raw `AccountId32` owner resolved from `Resources.UsernameOwnerOf`. */
+    accountId: `0x${string}`;
+    /** Signature bytes returned by the host wallet. */
+    signature: Uint8Array;
+}
+
+export type { Account as A, ChainApi as C, DotNsIdentitySignature as D, LocalStorageApi as L, SignMessageWithDotNsIdentityArgs as S, WalletApi as W, CloudStorageApi as a, App as b, AppConfig as c, CloudStorageConfig as d };

package/dist/wallet/index.d.ts

@@ -0,0 +1 @@
+export * from '@parity/product-sdk-signer';

package/dist/wallet/index.js

@@ -0,0 +1,3 @@
+export * from '@parity/product-sdk-signer';
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/wallet/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js","sourcesContent":[]}

package/package.json

@@ -0,0 +1,118 @@
+{
+  "name": "@parity/product-sdk",
+  "version": "0.0.0-dev.312.0",
+  "description": "Unified SDK for building products in the Polkadot ecosystem - umbrella package",
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./address": {
+      "import": "./dist/address/index.js",
+      "types": "./dist/address/index.d.ts"
+    },
+    "./cloud-storage": {
+      "import": "./dist/cloud-storage/index.js",
+      "types": "./dist/cloud-storage/index.d.ts"
+    },
+    "./chain": {
+      "import": "./dist/chain/index.js",
+      "types": "./dist/chain/index.d.ts"
+    },
+    "./contracts": {
+      "import": "./dist/contracts/index.js",
+      "types": "./dist/contracts/index.d.ts"
+    },
+    "./core": {
+      "import": "./dist/core/index.js",
+      "types": "./dist/core/index.d.ts"
+    },
+    "./crypto": {
+      "import": "./dist/crypto/index.js",
+      "types": "./dist/crypto/index.d.ts"
+    },
+    "./host": {
+      "import": "./dist/host/index.js",
+      "types": "./dist/host/index.d.ts"
+    },
+    "./identity": {
+      "import": "./dist/identity/index.js",
+      "types": "./dist/identity/index.d.ts"
+    },
+    "./individuality": {
+      "import": "./dist/individuality/index.js",
+      "types": "./dist/individuality/index.d.ts"
+    },
+    "./react": {
+      "import": "./dist/react/index.js",
+      "types": "./dist/react/index.d.ts"
+    },
+    "./local-storage": {
+      "import": "./dist/local-storage/index.js",
+      "types": "./dist/local-storage/index.d.ts"
+    },
+    "./wallet": {
+      "import": "./dist/wallet/index.js",
+      "types": "./dist/wallet/index.d.ts"
+    },
+    "./testing": {
+      "import": "./dist/testing/index.js",
+      "types": "./dist/testing/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "polkadot-api": "^2.1.6",
+    "@parity/product-sdk-cloud-storage": "0.0.0-dev.312.0",
+    "@parity/product-sdk-chain-client": "0.0.0-dev.312.0",
+    "@parity/product-sdk-contracts": "0.0.0-dev.312.0",
+    "@parity/product-sdk-host": "0.0.0-dev.312.0",
+    "@parity/product-sdk-crypto": "0.1.1",
+    "@parity/product-sdk-address": "0.1.1",
+    "@parity/product-sdk-individuality": "0.0.0-dev.312.0",
+    "@parity/product-sdk-keys": "0.0.0-dev.312.0",
+    "@parity/product-sdk-logger": "0.1.1",
+    "@parity/product-sdk-errors": "0.2.0",
+    "@parity/result": "0.2.0",
+    "@parity/product-sdk-signer": "0.0.0-dev.312.0",
+    "@parity/product-sdk-tx": "0.0.0-dev.312.0",
+    "@parity/product-sdk-local-storage": "0.0.0-dev.312.0"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "@types/react": "^18.0.0",
+    "react": "^18.0.0",
+    "typescript": "^5.7.0",
+    "vitest": "^3.0.0"
+  },
+  "keywords": [
+    "polkadot",
+    "parity",
+    "sdk",
+    "blockchain",
+    "web3"
+  ],
+  "license": "Apache-2.0",
+  "scripts": {
+    "build": "NODE_OPTIONS=--max-old-space-size=8192 tsup",
+    "test": "vitest run",
+    "clean": "rm -rf dist",
+    "typecheck": "tsc -p tsconfig.typecheck.json"
+  }
+}

package/src/address/index.ts

@@ -0,0 +1,8 @@
+// Copyright 2026 Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * @parity/product-sdk/address
+ *
+ * Re-exports from @parity/product-sdk-address.
+ */
+export * from "@parity/product-sdk-address";

package/src/chain/index.ts

@@ -0,0 +1,8 @@
+// Copyright 2026 Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * @parity/product-sdk/chain
+ *
+ * Re-exports from @parity/product-sdk-chain-client.
+ */
+export * from "@parity/product-sdk-chain-client";

package/src/cloud-storage/index.ts

@@ -0,0 +1,8 @@
+// Copyright 2026 Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * @parity/product-sdk/bulletin
+ *
+ * Re-exports from @parity/product-sdk-cloud-storage.
+ */
+export * from "@parity/product-sdk-cloud-storage";

package/src/contracts/index.ts

@@ -0,0 +1,8 @@
+// Copyright 2026 Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * @parity/product-sdk/contracts
+ *
+ * Re-exports from @parity/product-sdk-contracts.
+ */
+export * from "@parity/product-sdk-contracts";