@arcblock/nft 1.28.8 → 1.29.0

package/lib/recipient.d.cts

@@ -0,0 +1,40 @@
+//#region src/recipient.d.ts
+interface RecipientAttributes {
+  name: string;
+  location?: string;
+}
+interface WalletObject {
+  address: string;
+  publicKey: Uint8Array | string;
+}
+interface NFTRecipientParams extends RecipientAttributes {
+  wallet: WalletObject;
+}
+/**
+ * Represents an NFT recipient with wallet and metadata
+ */
+declare class NFTRecipient {
+  wallet: WalletObject;
+  attributes: RecipientAttributes;
+  /**
+   * Creates an instance of NFTRecipient.
+   *
+   * @param params - Recipient parameters
+   * @param params.wallet - wallet object
+   * @param params.name - recipient name
+   * @param params.location - recipient location
+   */
+  constructor({
+    wallet,
+    name,
+    location
+  }: NFTRecipientParams);
+  toJSON(): {
+    name: string;
+    location?: string;
+    did: string;
+    pk: any;
+  };
+}
+//#endregion
+export { NFTRecipient as default };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@arcblock/nft",
   "description": "Utility to create standard asset on forge powered blockchain",
-  "version": "1.28.8",
+  "version": "1.29.0",
   "author": {
     "name": "wangshijun",
     "email": "shijun@arcblock.io",
@@ -17,21 +17,49 @@
   "publishConfig": {
     "access": "public"
   },
+  "type": "module",
+  "main": "./lib/index.cjs",
+  "module": "./esm/index.mjs",
+  "types": "./esm/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./esm/index.d.mts",
+      "import": "./esm/index.mjs",
+      "default": "./lib/index.cjs"
+    },
+    "./lib/*.js": {
+      "types": "./esm/*.d.mts",
+      "import": "./esm/*.mjs",
+      "default": "./lib/*.cjs"
+    },
+    "./lib/*": {
+      "types": "./esm/*.d.mts",
+      "import": "./esm/*.mjs",
+      "default": "./lib/*.cjs"
+    }
+  },
+  "files": [
+    "lib",
+    "esm"
+  ],
   "dependencies": {
-    "@arcblock/did-util": "1.28.8",
-    "@arcblock/vc": "1.28.8",
-    "@ocap/client": "1.28.8",
-    "@ocap/tx-protocols": "1.28.8",
-    "@ocap/tx-util": "1.28.8",
-    "@ocap/util": "1.28.8",
-    "@ocap/wallet": "1.28.8",
-    "debug": "^4.3.6",
+    "@arcblock/did-util": "1.29.0",
+    "@arcblock/vc": "1.29.0",
+    "@ocap/client": "1.29.0",
+    "@ocap/tx-protocols": "1.29.0",
+    "@ocap/tx-util": "1.29.0",
+    "@ocap/util": "1.29.0",
+    "@ocap/wallet": "1.29.0",
+    "debug": "^4.4.3",
     "json-stable-stringify": "^1.0.1",
-    "lodash": "^4.17.21",
+    "lodash": "^4.17.23",
     "pako": "^1.0.11"
   },
   "devDependencies": {
-    "@ocap/e2e-test": "1.28.8",
+    "@ocap/e2e-test": "1.29.0",
+    "@types/debug": "^4.1.12",
+    "@types/json-stable-stringify": "^1.0.36",
+    "@types/lodash": "^4.17.13",
     "remark-cli": "^10.0.1",
     "remark-preset-github": "^4.0.4"
   },
@@ -53,15 +81,13 @@
     "nodejs"
   ],
   "license": "Apache-2.0",
-  "main": "./lib/index.js",
-  "files": [
-    "lib"
-  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/ArcBlock/blockchain/tree/master/asset/nft"
   },
   "scripts": {
+    "build": "tsdown",
+    "prebuild": "rm -rf lib esm",
     "lint": "biome check",
     "lint:fix": "biome check --write",
     "docs": "bun run gen-dts && bun run gen-docs && bun run cleanup-docs && bun run format-docs",

package/lib/enum.d.ts

@@ -1,18 +0,0 @@
-export const NFTType: Readonly<{
-    ticket: number;
-    coupon: number;
-    certificate: number;
-    badge: number;
-    license: number;
-    giftcard: number;
-    passport: number;
-    idcard: number;
-    receipt: number;
-    other: number;
-}>;
-export const NFTStatus: Readonly<{
-    normal: number;
-    consumed: number;
-    invalid: number;
-    expired: number;
-}>;

package/lib/enum.js

@@ -1,21 +0,0 @@
-const NFTType = Object.freeze({
-  ticket: 0,
-  coupon: 1,
-  certificate: 2,
-  badge: 3,
-  license: 4,
-  giftcard: 5,
-  passport: 6,
-  idcard: 7,
-  receipt: 8,
-  other: 127,
-});
-
-const NFTStatus = Object.freeze({
-  normal: 0,
-  consumed: 1,
-  invalid: 2,
-  expired: 3,
-});
-
-module.exports = { NFTType, NFTStatus };

package/lib/factory.d.ts

@@ -1,165 +0,0 @@
-export = NFTFactory;
-/**
- * Used to create standard asset on forge powered blockchain
- * All assets are signed assets, eg, the asset data are self approvable
- *
- * @class NFTFactory
- */
-declare class NFTFactory {
-    /**
-     * Creates an instance of NFTFactory.
-     * @param {object} params
-     * @param {string} params.chainHost - on which chain to create wallet
-     * @param {WalletObject} params.wallet - issuer wallet
-     * @param {object} params.issuer - issuer attributes, such as name, url and logo
-     * @memberof NFTFactory
-     */
-    constructor({ chainHost, wallet, issuer }: {
-        chainHost: string;
-        wallet: WalletObject;
-        issuer: object;
-    });
-    chainHost: string;
-    client: Client;
-    wallet: WalletObject;
-    issuer: NFTIssuer;
-    /**
-     * Create a ticket
-     *
-     * @param {object} params
-     * @param {string} params.display - display of the ticket { type, content }
-     * @param {object} params.data - asset payload
-     * @param {string} params.data.name - ticket name
-     * @param {string} params.data.description - ticket description
-     * @param {string} params.data.location - event location
-     * @param {number} params.data.startTime - event start time
-     * @param {number} params.data.endTime - event end time
-     * @param {object} params.attributes - asset attributes
-     * @returns {Promise} - the `[asset, hash]` on resolved
-     * @memberof NFTFactory
-     */
-    createTicket({ display, data, attributes }: {
-        display: string;
-        data: {
-            name: string;
-            description: string;
-            location: string;
-            startTime: number;
-            endTime: number;
-        };
-        attributes: object;
-    }): Promise<any>;
-    /**
-     * Create a coupon asset
-     *
-     * @param {object} params
-     * @param {string} params.display - display of the coupon { type, content }
-     * @param {object} params.data - asset payload
-     * @param {string} params.data.name - coupon name
-     * @param {string} params.data.description - coupon description
-     * @param {number} params.data.ratio - discount ratio
-     * @param {number} params.data.amount - discount amount
-     * @param {number} params.data.minAmount - min order amount that this coupon can be used
-     * @param {number} params.data.startTime - event start time
-     * @param {number} params.data.endTime - event end time
-     * @param {object} params.attributes - asset attributes
-     * @returns {Promise} - the `[asset, hash]` on resolved
-     * @memberof NFTFactory
-     */
-    createCoupon({ display, data, attributes }: {
-        display: string;
-        data: {
-            name: string;
-            description: string;
-            ratio: number;
-            amount: number;
-            minAmount: number;
-            startTime: number;
-            endTime: number;
-        };
-        attributes: object;
-    }): Promise<any>;
-    /**
-     * Create a coupon asset
-     *
-     * @param {object} params
-     * @param {string} params.display - display of the coupon { type, content }
-     * @param {object} params.data - asset payload
-     * @param {string} params.data.name - certificate name
-     * @param {string} params.data.description - certificate description
-     * @param {string} params.data.reason - certificate reason
-     * @param {string} params.data.logoUrl - certificate logo
-     * @param {NFTRecipient} params.data.recipient - certificate recipient
-     * @param {number} params.data.issueTime - when was certificate issued
-     * @param {number} params.data.expireTime - when will certificate expire
-     * @param {object} params.attributes - asset attributes
-     * @returns {Promise} - the `[asset, hash]` on resolved
-     * @memberof NFTFactory
-     */
-    createCertificate({ display, data, attributes }: {
-        display: string;
-        data: {
-            name: string;
-            description: string;
-            reason: string;
-            logoUrl: string;
-            recipient: NFTRecipient;
-            issueTime: number;
-            expireTime: number;
-        };
-        attributes: object;
-    }): Promise<any>;
-    /**
-     * Create a badge
-     *
-     * @param {object} params
-     * @param {string} params.display - display of the badge { type, content }
-     * @param {object} params.data - asset payload
-     * @param {string} params.data.name - certificate name
-     * @param {string} params.data.description - certificate description
-     * @param {NFTRecipient} params.data.recipient - certificate recipient
-     * @param {object} params.attributes - asset attributes
-     * @returns {Promise} - the `[asset, hash]` on resolved
-     * @memberof NFTFactory
-     */
-    createBadge({ display, data, attributes }: {
-        display: string;
-        data: {
-            name: string;
-            description: string;
-            recipient: NFTRecipient;
-        };
-        attributes: object;
-    }): Promise<any>;
-    /**
-     * Create a passport
-     *
-     * @param {object} params
-     * @param {string} params.display - display of the passport { type, content }
-     * @param {object} params.passport - asset payload
-     * @param {string} params.passport.name - passport name
-     * @param {string} params.passport.title - passport title
-     * @param {NFTRecipient} params.data.recipient - certificate recipient
-     * @param {object} params.attributes - asset attributes
-     * @returns {Promise} - the `[asset, hash]` on resolved
-     * @memberof NFTFactory
-     */
-    createPassport({ display, data, attributes }: {
-        display: string;
-        passport: {
-            name: string;
-            title: string;
-        };
-    }): Promise<any>;
-    createSignedAsset(payload: any, attributes: any): Promise<any[]>;
-    _createDisplay(display: any): any;
-    _createCert({ display, data, attributes }: {
-        display?: string;
-        data?: {};
-        attributes?: {};
-    }): Promise<any[]>;
-    getVCBody(asset: any): any;
-}
-import Client = require("@ocap/client");
-import NFTIssuer = require("./issuer");
-import NFTRecipient = require("./recipient");