@microsoft/ccf-app 2.0.3 → 3.0.0-dev1

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/converters.d.ts CHANGED
@@ -3,8 +3,8 @@ export interface DataConverter<T> {
3
3
  encode(val: T): ArrayBuffer;
4
4
  decode(arr: ArrayBuffer): T;
5
5
  }
6
- declare type TypedArray = ArrayBufferView;
7
- interface TypedArrayConstructor<T extends TypedArray> {
6
+ export declare type TypedArray = ArrayBufferView;
7
+ export interface TypedArrayConstructor<T extends TypedArray> {
8
8
  new (buffer: ArrayBuffer, byteOffset?: number, length?: number): T;
9
9
  }
10
10
  /**
@@ -186,4 +186,3 @@ export declare const typedArray: <T extends TypedArray>(clazz: TypedArrayConstru
186
186
  * type is `ArrayBuffer`, in which case no conversion is applied.
187
187
  */
188
188
  export declare const arrayBuffer: DataConverter<ArrayBuffer>;
189
- export {};
package/global.d.ts CHANGED
@@ -216,7 +216,7 @@ export interface CCFRpc {
216
216
  * Set a claims digest to be associated with the transaction if it succeeds. This
217
217
  * digest can later be accessed from the receipt, and expanded into a full claim.
218
218
  *
219
- * The `digest` argument must be a sha-256 ArrayBuffer, eg. produced by {@link CCF.digest}
219
+ * The `digest` argument must be a sha-256 ArrayBuffer, eg. produced by {@link global!CCF.digest}.
220
220
  */
221
221
  setClaimsDigest(digest: ArrayBuffer): void;
222
222
  }
@@ -274,7 +274,7 @@ export interface CCFHistorical {
274
274
  *
275
275
  * If the requested range failed to be retrieved then `null` is returned.
276
276
  * This may happen if the range is not known to the node (see also
277
- * {@linkcode CCFConsensus.getStatusForTxId | getStatusForTxId}) or not available for
277
+ * {@linkcode global!CCFConsensus.getStatusForTxId | getStatusForTxId}) or not available for
278
278
  * other reasons (for example, the node is missing ledger files on disk).
279
279
  */
280
280
  getStateRange(handle: number, startSeqno: number, endSeqno: number, secondsUntilExpiry: number): HistoricalState[] | null;
package/historical.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  /**
2
- * @inheritDoc CCF.historicalState
2
+ * @inheritDoc global!CCF.historicalState
3
3
  */
4
4
  export declare const historicalState: import("./global.js").HistoricalState | undefined;
5
5
  /**
package/historical.js CHANGED
@@ -29,7 +29,7 @@
29
29
  */
30
30
  import { ccf } from "./global.js";
31
31
  /**
32
- * @inheritDoc CCF.historicalState
32
+ * @inheritDoc global!CCF.historicalState
33
33
  */
34
34
  export const historicalState = ccf.historicalState;
35
35
  /**
package/kv.d.ts CHANGED
@@ -63,7 +63,7 @@ export declare class TypedKvMap<K, V> {
63
63
  */
64
64
  export declare function typedKv<K, V>(nameOrMap: string | KvMap, kt: DataConverter<K>, vt: DataConverter<V>): TypedKvMap<K, V>;
65
65
  /**
66
- * @inheritDoc CCF.kv
66
+ * @inheritDoc global!CCF.kv
67
67
  */
68
68
  export declare const rawKv: import("./global.js").KvMaps;
69
69
  export { KvMap, KvMaps } from "./global";
package/kv.js CHANGED
@@ -89,6 +89,6 @@ export function typedKv(nameOrMap, kt, vt) {
89
89
  return new TypedKvMap(kvMap, kt, vt);
90
90
  }
91
91
  /**
92
- * @inheritDoc CCF.kv
92
+ * @inheritDoc global!CCF.kv
93
93
  */
94
94
  export const rawKv = ccf.kv;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@microsoft/ccf-app",
3
- "version": "2.0.3",
3
+ "version": "3.0.0-dev1",
4
4
  "description": "CCF app support package",
5
5
  "main": "index.js",
6
6
  "files": [
@@ -20,7 +20,7 @@
20
20
  "devDependencies": {
21
21
  "@types/chai": "^4.2.15",
22
22
  "@types/mocha": "^9.0.0",
23
- "@types/node": "^17.0.8",
23
+ "@types/node": "^18.0.0",
24
24
  "@types/node-forge": "^1.0.0",
25
25
  "chai": "^4.3.4",
26
26
  "colors": "1.4.0",
@@ -28,7 +28,7 @@
28
28
  "mocha": "^10.0.0",
29
29
  "node-forge": "^1.2.0",
30
30
  "ts-node": "^10.4.0",
31
- "typedoc": "^0.22.7",
31
+ "typedoc": "^0.23.1",
32
32
  "typescript": "^4.2.4"
33
33
  }
34
34
  }