@iota/kiosk 0.0.0-dev-20251015065834

package/CHANGELOG.md

@@ -0,0 +1,198 @@
+# @iota/kiosk
+
+## 0.0.0-dev-20251015065834
+
+### Patch Changes
+
+-   Updated dependencies [c12d044]
+-   Updated dependencies [a0b225d]
+-   Updated dependencies [4c68076]
+-   Updated dependencies [92dd15e]
+    -   @iota/iota-sdk@0.0.0-dev-20251015065834
+
+## 0.4.8
+
+### Patch Changes
+
+-   Updated dependencies [3244c29]
+    -   @iota/iota-sdk@1.6.1
+
+## 0.4.7
+
+### Patch Changes
+
+-   Updated dependencies [c5543f0]
+-   Updated dependencies [bd17ba9]
+-   Updated dependencies [0accdb0]
+    -   @iota/iota-sdk@1.6.0
+
+## 0.4.6
+
+### Patch Changes
+
+-   3c1d088: Fix doc comment on `getKiosk` command
+-   Updated dependencies [40576ed]
+-   Updated dependencies [61b0944]
+-   Updated dependencies [966f83c]
+-   Updated dependencies [f008db3]
+-   Updated dependencies [733df30]
+-   Updated dependencies [13ca264]
+-   Updated dependencies [5bbafa8]
+-   Updated dependencies [28ce666]
+-   Updated dependencies [c855f8c]
+-   Updated dependencies [f008db3]
+-   Updated dependencies [464c15a]
+    -   @iota/iota-sdk@1.5.0
+
+## 0.4.5
+
+### Patch Changes
+
+-   Updated dependencies [f04033d]
+-   Updated dependencies [59342b2]
+-   Updated dependencies [ecea738]
+    -   @iota/iota-sdk@1.4.0
+
+## 0.4.4
+
+### Patch Changes
+
+-   Updated dependencies [6051799]
+-   Updated dependencies [5db9797]
+-   Updated dependencies [c4c6d9a]
+-   Updated dependencies [c837b79]
+    -   @iota/iota-sdk@1.3.0
+
+## 0.4.3
+
+### Patch Changes
+
+-   Updated dependencies [53d5058]
+    -   @iota/iota-sdk@1.2.0
+
+## 0.4.2
+
+### Patch Changes
+
+-   Updated dependencies [acc502a]
+-   Updated dependencies [1128809]
+    -   @iota/iota-sdk@1.1.0
+
+## 0.4.1
+
+### Patch Changes
+
+-   Updated dependencies [26cf13b]
+    -   @iota/iota-sdk@1.0.1
+
+## 0.4.0
+
+### Minor Changes
+
+-   864fd32: Rename `getLatestIotaSystemState` to `getLatestIotaSystemStateV1` and add a new
+    backwards-compatible and future-proof `getLatestIotaSystemState` method that dynamically calls
+    ``getLatestIotaSystemStateV1`or`getLatestIotaSystemStateV2` based on the protocol version of the
+    node.
+
+### Patch Changes
+
+-   Updated dependencies [f4d75c7]
+-   Updated dependencies [daa968f]
+-   Updated dependencies [864fd32]
+    -   @iota/iota-sdk@1.0.0
+
+## 0.3.4
+
+### Patch Changes
+
+-   1ad39f9: Update dependencies
+-   Updated dependencies [42898f1]
+-   Updated dependencies [1ad39f9]
+-   Updated dependencies [bdb736e]
+-   Updated dependencies [65a0900]
+    -   @iota/iota-sdk@0.7.0
+
+## 0.3.3
+
+### Patch Changes
+
+-   Updated dependencies [1a4505b]
+-   Updated dependencies [e629a39]
+-   Updated dependencies [2717145]
+-   Updated dependencies [3fe0747]
+-   Updated dependencies [e213517]
+    -   @iota/iota-sdk@0.6.0
+
+## 0.3.2
+
+### Patch Changes
+
+-   Updated dependencies [6e00091]
+    -   @iota/iota-sdk@0.5.0
+
+## 0.3.1
+
+### Patch Changes
+
+-   5214d28: Update documentation urls
+-   Updated dependencies [5214d28]
+    -   @iota/iota-sdk@0.4.1
+
+## 0.3.0
+
+### Minor Changes
+
+-   9864dcb: Add default royalty, kiosk lock, floor price & personal kiosk rules package ids to
+    testnet network
+
+### Patch Changes
+
+-   Updated dependencies [9864dcb]
+    -   @iota/iota-sdk@0.4.0
+
+## 0.2.1
+
+### Patch Changes
+
+-   220fa7a: First public release.
+-   Updated dependencies [220fa7a]
+    -   @iota/iota-sdk@0.3.1
+
+## 0.2.0
+
+### Minor Changes
+
+-   6eabd18: Changes for compatibility with the node, simplification of exposed APIs and general
+    improvements.
+
+### Patch Changes
+
+-   Updated dependencies [6eabd18]
+    -   @iota/iota-sdk@0.3.0
+
+## 0.1.2
+
+### Patch Changes
+
+-   Updated dependencies [d423314]
+-   Updated dependencies [b91a3d5]
+-   Updated dependencies [a3c1937]
+    -   @iota/iota-sdk@0.2.0
+
+## 0.1.1
+
+### Patch Changes
+
+-   Updated dependencies [4a4ba5a]
+    -   @iota/iota-sdk@0.1.1
+
+## 0.1.0
+
+### Minor Changes
+
+-   249a7d0: First release
+
+### Patch Changes
+
+-   Updated dependencies [249a7d0]
+    -   @iota/iota-sdk@0.1.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 [yyyy] [name of copyright owner]
+
+   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

@@ -0,0 +1,39 @@
+# Kiosk SDK
+
+`@iota/kiosk` is part of the **IOTA Rebased SDK**, designed specifically for interacting with the IOTA Rebased protocol.
+
+This Kiosk SDK library provides different utilities to interact/create/manage a
+[Kiosk](https://github.com/iotaledger/iota/tree/develop/kiosk).
+
+[You can read the documentation and see examples by clicking here.](https://docs.iota.org/developer/ts-sdk/kiosk)
+
+## Install
+
+To use the Kiosk SDK in your project, run the following command in your project root:
+
+```sh npm2yarn
+npm i @iota/kiosk @iota/iota-sdk
+```
+
+To use the Kiosk SDK, you must create a [KioskClient](https://docs.iota.org/developer/ts-sdk/kiosk/kiosk-client/introduction) instance.
+
+## Setup
+
+You can follow this example to create a KioskClient.
+
+```typescript
+import { KioskClient } from '@iota/kiosk';
+import { getFullnodeUrl, IotaClient, Network } from '@iota/iota-sdk/client';
+
+// We need an IOTA Client. You can re-use the IotaClient of your project
+// (it's not recommended to create a new one).
+const client = new IotaClient({ url: getFullnodeUrl(Network.Testnet) });
+
+// Now we can use it to create a kiosk Client.
+const kioskClient = new KioskClient({
+    client,
+    network: Network.Testnet,
+});
+```
+
+You can read the KioskClient documentation to query kiosk data [here](https://docs.iota.org/developer/ts-sdk/kiosk/kiosk-client/querying).

package/dist/cjs/bcs.d.ts

@@ -0,0 +1,38 @@
+export declare const KioskType: import("@iota/iota-sdk/bcs").BcsType<{
+    id: string;
+    profits: string;
+    owner: string;
+    itemCount: number;
+}, {
+    id: string | Uint8Array;
+    profits: string | number | bigint;
+    owner: string | Uint8Array;
+    itemCount: number;
+}>;
+export declare const KioskPurchaseCap: import("@iota/iota-sdk/bcs").BcsType<{
+    id: string;
+    kioskId: string;
+    itemId: string;
+    minPrice: string;
+}, {
+    id: string | Uint8Array;
+    kioskId: string | Uint8Array;
+    itemId: string | Uint8Array;
+    minPrice: string | number | bigint;
+}>;
+export declare const TransferPolicyCreatedEvent: import("@iota/iota-sdk/bcs").BcsType<{
+    id: string;
+}, {
+    id: string | Uint8Array;
+}>;
+export declare const TransferPolicyType: import("@iota/iota-sdk/bcs").BcsType<{
+    id: string;
+    balance: string;
+    rules: string[];
+}, {
+    id: string | Uint8Array;
+    balance: string | number | bigint;
+    rules: Iterable<string> & {
+        length: number;
+    };
+}>;

package/dist/cjs/bcs.js

@@ -0,0 +1,49 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var bcs_exports = {};
+__export(bcs_exports, {
+  KioskPurchaseCap: () => KioskPurchaseCap,
+  KioskType: () => KioskType,
+  TransferPolicyCreatedEvent: () => TransferPolicyCreatedEvent,
+  TransferPolicyType: () => TransferPolicyType
+});
+module.exports = __toCommonJS(bcs_exports);
+var import_bcs = require("@iota/iota-sdk/bcs");
+var import_types = require("./types/index.js");
+const KioskType = import_bcs.bcs.struct(import_types.KIOSK_TYPE, {
+  id: import_bcs.bcs.Address,
+  profits: import_bcs.bcs.u64(),
+  owner: import_bcs.bcs.Address,
+  itemCount: import_bcs.bcs.u32()
+});
+const KioskPurchaseCap = import_bcs.bcs.struct(import_types.KIOSK_PURCHASE_CAP, {
+  id: import_bcs.bcs.Address,
+  kioskId: import_bcs.bcs.Address,
+  itemId: import_bcs.bcs.Address,
+  minPrice: import_bcs.bcs.u64()
+});
+const TransferPolicyCreatedEvent = import_bcs.bcs.struct(import_types.TRANSFER_POLICY_CREATED_EVENT, {
+  id: import_bcs.bcs.Address
+});
+const TransferPolicyType = import_bcs.bcs.struct(import_types.TRANSFER_POLICY_TYPE, {
+  id: import_bcs.bcs.Address,
+  balance: import_bcs.bcs.u64(),
+  rules: import_bcs.bcs.vector(import_bcs.bcs.string())
+});
+//# sourceMappingURL=bcs.js.map

package/dist/cjs/bcs.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/bcs.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// Modifications Copyright (c) 2024 IOTA Stiftung\n// SPDX-License-Identifier: Apache-2.0\n\nimport { bcs } from '@iota/iota-sdk/bcs';\n\nimport {\n    KIOSK_PURCHASE_CAP,\n    KIOSK_TYPE,\n    TRANSFER_POLICY_CREATED_EVENT,\n    TRANSFER_POLICY_TYPE,\n} from './types/index.js';\n\n// Register the `Kiosk` struct for faster queries.\nexport const KioskType = bcs.struct(KIOSK_TYPE, {\n    id: bcs.Address,\n    profits: bcs.u64(),\n    owner: bcs.Address,\n    itemCount: bcs.u32(),\n});\n\n// Register the `PurchaseCap` for faster queries.\nexport const KioskPurchaseCap = bcs.struct(KIOSK_PURCHASE_CAP, {\n    id: bcs.Address,\n    kioskId: bcs.Address,\n    itemId: bcs.Address,\n    minPrice: bcs.u64(),\n});\n\n// Register the `TransferPolicyCreated` event data.\nexport const TransferPolicyCreatedEvent = bcs.struct(TRANSFER_POLICY_CREATED_EVENT, {\n    id: bcs.Address,\n});\n\nexport const TransferPolicyType = bcs.struct(TRANSFER_POLICY_TYPE, {\n    id: bcs.Address,\n    balance: bcs.u64(),\n    rules: bcs.vector(bcs.string()),\n});\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAIA,iBAAoB;AAEpB,mBAKO;AAGA,MAAM,YAAY,eAAI,OAAO,yBAAY;AAAA,EAC5C,IAAI,eAAI;AAAA,EACR,SAAS,eAAI,IAAI;AAAA,EACjB,OAAO,eAAI;AAAA,EACX,WAAW,eAAI,IAAI;AACvB,CAAC;AAGM,MAAM,mBAAmB,eAAI,OAAO,iCAAoB;AAAA,EAC3D,IAAI,eAAI;AAAA,EACR,SAAS,eAAI;AAAA,EACb,QAAQ,eAAI;AAAA,EACZ,UAAU,eAAI,IAAI;AACtB,CAAC;AAGM,MAAM,6BAA6B,eAAI,OAAO,4CAA+B;AAAA,EAChF,IAAI,eAAI;AACZ,CAAC;AAEM,MAAM,qBAAqB,eAAI,OAAO,mCAAsB;AAAA,EAC/D,IAAI,eAAI;AAAA,EACR,SAAS,eAAI,IAAI;AAAA,EACjB,OAAO,eAAI,OAAO,eAAI,OAAO,CAAC;AAClC,CAAC;",
+  "names": []
+}

package/dist/cjs/client/kiosk-client.d.ts

@@ -0,0 +1,76 @@
+import type { NetworkId } from '@iota/iota-sdk/client';
+import type { PaginationArguments, IotaClient } from '@iota/iota-sdk/client';
+import type { BaseRulePackageIds, TransferPolicyRule } from '../constants.js';
+import type { FetchKioskOptions, KioskClientOptions, KioskData, OwnedKiosks } from '../types/index.js';
+/**
+ * A Client that allows you to interact with kiosk.
+ * Offers utilities to query kiosk, craft transactions to edit your own kiosk,
+ * purchase, manage transfer policies, create new kiosks etc.
+ * If you pass packageIds, all functionality will be managed using these packages.
+ */
+export declare class KioskClient {
+    client: IotaClient;
+    network: NetworkId;
+    rules: TransferPolicyRule[];
+    packageIds?: BaseRulePackageIds;
+    constructor(options: KioskClientOptions);
+    /**
+     * Get an addresses's owned kiosks.
+     * @param address The address for which we want to retrieve the kiosks.
+     * @param pagination Optional pagination arguments.
+     * @returns An Object containing all the `kioskOwnerCap` objects as well as the kioskIds.
+     */
+    getOwnedKiosks({ address, pagination, }: {
+        address: string;
+        pagination?: PaginationArguments<string>;
+    }): Promise<OwnedKiosks>;
+    /**
+     * Fetches the kiosk contents.
+     * @param id The ID of the kiosk to fetch.
+     * @param options Optional to control the fetch behavior.
+     * @returns
+     */
+    getKiosk({ id, options, }: {
+        id: string;
+        options?: FetchKioskOptions;
+    }): Promise<KioskData>;
+    /**
+     * Fetch the extension data (if any) for a kiosk, by type
+     * @param kioskId The ID of the kiosk to lookup
+     * @param extensionType The Type of the extension (can be used from by using the type returned by `getKiosk()`)
+     */
+    getKioskExtension({ kioskId, type }: {
+        kioskId: string;
+        type: string;
+    }): Promise<import("../types/kiosk.js").KioskExtension | null>;
+    /**
+     * Query the Transfer Policy(ies) for type `T`.
+     * @param type The Type we're querying for (E.g `0xMyAddress::hero::Hero`)
+     */
+    getTransferPolicies({ type }: {
+        type: string;
+    }): Promise<import("../types/transfer-policy.js").TransferPolicy[]>;
+    /**
+     * Query all the owned transfer policies for an address.
+     * Returns `TransferPolicyCap` which uncludes `policyId, policyCapId, type`.
+     * @param address The address we're searching the owned transfer policies for.
+     */
+    getOwnedTransferPolicies({ address }: {
+        address: string;
+    }): Promise<import("../types/transfer-policy.js").TransferPolicyCap[] | undefined>;
+    /**
+     * Query the Transfer Policy Cap for type `T`, owned by `address`
+     * @param type The Type `T` for the object
+     * @param address The address that owns the cap.
+     */
+    getOwnedTransferPoliciesByType({ type, address }: {
+        type: string;
+        address: string;
+    }): Promise<import("../types/transfer-policy.js").TransferPolicyCap[]>;
+    addRuleResolver(rule: TransferPolicyRule): void;
+    /**
+     * A convenient helper to get the packageIds for our supported ruleset,
+     * based on `kioskClient` configuration.
+     */
+    getRulePackageId(rule: 'kioskLockRulePackageId' | 'royaltyRulePackageId' | 'personalKioskRulePackageId' | 'floorPriceRulePackageId'): string;
+}