diff --git a/CHANGELOG.md b/CHANGELOG.md index 1916c89a..21820bdb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,10 +6,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). ### Added ### Fixed -- Fix DhtOps helper functions `getChainOpType`, `getChainOpAction`, `getChainOpEntry` and `getChainOpSignature` to adhere to the new types ### Changed ### Removed +## 2024-12-17: v0.18.0-rc.2 +### Fixed +- Fix DhtOps helper functions `getChainOpType`, `getChainOpAction`, `getChainOpEntry` and `getChainOpSignature` to adhere to the new types + ## 2024-12-01: v0.18.0-rc.1 ### Changed - Change `InstallAppRequest` type to adhere to the new format that includes the `roles_settings` field and removes diff --git a/docs/client.chainop.md b/docs/client.chainop.md index 11389eaf..79b0d55d 100644 --- a/docs/client.chainop.md +++ b/docs/client.chainop.md @@ -9,28 +9,32 @@ ```typescript export type ChainOp = { - [DhtOpType.StoreRecord]: [Signature, Action, Entry | undefined]; + [ChainOpType.StoreRecord]: [Signature, Action, Entry | undefined]; } | { - [DhtOpType.StoreEntry]: [Signature, NewEntryAction, Entry]; + [ChainOpType.StoreEntry]: [Signature, NewEntryAction, Entry]; } | { - [DhtOpType.RegisterAgentActivity]: [Signature, Action]; + [ChainOpType.RegisterAgentActivity]: [Signature, Action]; } | { - [DhtOpType.RegisterUpdatedContent]: [ + [ChainOpType.RegisterUpdatedContent]: [ Signature, Update, Entry | undefined ]; } | { - [DhtOpType.RegisterUpdatedRecord]: [Signature, Update, Entry | undefined]; + [ChainOpType.RegisterUpdatedRecord]: [ + Signature, + Update, + Entry | undefined + ]; } | { - [DhtOpType.RegisterDeletedBy]: [Signature, Delete]; + [ChainOpType.RegisterDeletedBy]: [Signature, Delete]; } | { - [DhtOpType.RegisterDeletedEntryAction]: [Signature, Delete]; + [ChainOpType.RegisterDeletedEntryAction]: [Signature, Delete]; } | { - [DhtOpType.RegisterAddLink]: [Signature, CreateLink]; + [ChainOpType.RegisterAddLink]: [Signature, CreateLink]; } | { - [DhtOpType.RegisterRemoveLink]: [Signature, DeleteLink]; + [ChainOpType.RegisterRemoveLink]: [Signature, DeleteLink]; }; ``` -**References:** [DhtOpType.StoreRecord](./client.dhtoptype.md), [Signature](./client.signature.md), [Action](./client.action.md), [Entry](./client.entry.md), [DhtOpType.StoreEntry](./client.dhtoptype.md), [NewEntryAction](./client.newentryaction.md), [DhtOpType.RegisterAgentActivity](./client.dhtoptype.md), [DhtOpType.RegisterUpdatedContent](./client.dhtoptype.md), [Update](./client.update.md), [DhtOpType.RegisterUpdatedRecord](./client.dhtoptype.md), [DhtOpType.RegisterDeletedBy](./client.dhtoptype.md), [Delete](./client.delete.md), [DhtOpType.RegisterDeletedEntryAction](./client.dhtoptype.md), [DhtOpType.RegisterAddLink](./client.dhtoptype.md), [CreateLink](./client.createlink.md), [DhtOpType.RegisterRemoveLink](./client.dhtoptype.md), [DeleteLink](./client.deletelink.md) +**References:** [ChainOpType.StoreRecord](./client.chainoptype.md), [Signature](./client.signature.md), [Action](./client.action.md), [Entry](./client.entry.md), [ChainOpType.StoreEntry](./client.chainoptype.md), [NewEntryAction](./client.newentryaction.md), [ChainOpType.RegisterAgentActivity](./client.chainoptype.md), [ChainOpType.RegisterUpdatedContent](./client.chainoptype.md), [Update](./client.update.md), [ChainOpType.RegisterUpdatedRecord](./client.chainoptype.md), [ChainOpType.RegisterDeletedBy](./client.chainoptype.md), [Delete](./client.delete.md), [ChainOpType.RegisterDeletedEntryAction](./client.chainoptype.md), [ChainOpType.RegisterAddLink](./client.chainoptype.md), [CreateLink](./client.createlink.md), [ChainOpType.RegisterRemoveLink](./client.chainoptype.md), [DeleteLink](./client.deletelink.md) diff --git a/docs/client.dhtoptype.md b/docs/client.chainoptype.md similarity index 77% rename from docs/client.dhtoptype.md rename to docs/client.chainoptype.md index 38f0bf6e..fb9fdc02 100644 --- a/docs/client.dhtoptype.md +++ b/docs/client.chainoptype.md @@ -1,14 +1,14 @@ -[Home](./index.md) > [@holochain/client](./client.md) > [DhtOpType](./client.dhtoptype.md) +[Home](./index.md) > [@holochain/client](./client.md) > [ChainOpType](./client.chainoptype.md) -## DhtOpType enum +## ChainOpType enum **Signature:** ```typescript -export declare enum DhtOpType +export declare enum ChainOpType ``` ## Enumeration Members diff --git a/docs/client.getdhtopaction.md b/docs/client.getchainopaction.md similarity index 65% rename from docs/client.getdhtopaction.md rename to docs/client.getchainopaction.md index fc492271..aaa6b2f0 100644 --- a/docs/client.getdhtopaction.md +++ b/docs/client.getchainopaction.md @@ -1,14 +1,14 @@ -[Home](./index.md) > [@holochain/client](./client.md) > [getDhtOpAction](./client.getdhtopaction.md) +[Home](./index.md) > [@holochain/client](./client.md) > [getChainOpAction](./client.getchainopaction.md) -## getDhtOpAction() function +## getChainOpAction() function **Signature:** ```typescript -export declare function getDhtOpAction(op: DhtOp): Action; +export declare function getChainOpAction(op: ChainOp): Action; ``` ## Parameters @@ -36,7 +36,7 @@ op -[DhtOp](./client.dhtop.md) +[ChainOp](./client.chainop.md) diff --git a/docs/client.getdhtopentry.md b/docs/client.getchainopentry.md similarity index 65% rename from docs/client.getdhtopentry.md rename to docs/client.getchainopentry.md index eb6bc1cb..4d135a9e 100644 --- a/docs/client.getdhtopentry.md +++ b/docs/client.getchainopentry.md @@ -1,14 +1,14 @@ -[Home](./index.md) > [@holochain/client](./client.md) > [getDhtOpEntry](./client.getdhtopentry.md) +[Home](./index.md) > [@holochain/client](./client.md) > [getChainOpEntry](./client.getchainopentry.md) -## getDhtOpEntry() function +## getChainOpEntry() function **Signature:** ```typescript -export declare function getDhtOpEntry(op: DhtOp): Entry | undefined; +export declare function getChainOpEntry(op: ChainOp): Entry | undefined; ``` ## Parameters @@ -36,7 +36,7 @@ op -[DhtOp](./client.dhtop.md) +[ChainOp](./client.chainop.md) diff --git a/docs/client.getdhtopsignature.md b/docs/client.getchainopsignature.md similarity index 64% rename from docs/client.getdhtopsignature.md rename to docs/client.getchainopsignature.md index cb20c6e9..72d57062 100644 --- a/docs/client.getdhtopsignature.md +++ b/docs/client.getchainopsignature.md @@ -1,14 +1,14 @@ -[Home](./index.md) > [@holochain/client](./client.md) > [getDhtOpSignature](./client.getdhtopsignature.md) +[Home](./index.md) > [@holochain/client](./client.md) > [getChainOpSignature](./client.getchainopsignature.md) -## getDhtOpSignature() function +## getChainOpSignature() function **Signature:** ```typescript -export declare function getDhtOpSignature(op: DhtOp): Signature; +export declare function getChainOpSignature(op: ChainOp): Signature; ``` ## Parameters @@ -36,7 +36,7 @@ op -[DhtOp](./client.dhtop.md) +[ChainOp](./client.chainop.md) diff --git a/docs/client.getdhtoptype.md b/docs/client.getchainoptype.md similarity index 60% rename from docs/client.getdhtoptype.md rename to docs/client.getchainoptype.md index e5128c60..b2709b3a 100644 --- a/docs/client.getdhtoptype.md +++ b/docs/client.getchainoptype.md @@ -1,14 +1,14 @@ -[Home](./index.md) > [@holochain/client](./client.md) > [getDhtOpType](./client.getdhtoptype.md) +[Home](./index.md) > [@holochain/client](./client.md) > [getChainOpType](./client.getchainoptype.md) -## getDhtOpType() function +## getChainOpType() function **Signature:** ```typescript -export declare function getDhtOpType(op: DhtOp): DhtOpType; +export declare function getChainOpType(op: ChainOp): ChainOpType; ``` ## Parameters @@ -36,7 +36,7 @@ op -[DhtOp](./client.dhtop.md) +[ChainOp](./client.chainop.md) @@ -46,5 +46,5 @@ op **Returns:** -[DhtOpType](./client.dhtoptype.md) +[ChainOpType](./client.chainoptype.md) diff --git a/docs/client.md b/docs/client.md index 3c549343..d71ea707 100644 --- a/docs/client.md +++ b/docs/client.md @@ -143,7 +143,7 @@ Description -[DhtOpType](./client.dhtoptype.md) +[ChainOpType](./client.chainoptype.md) @@ -281,7 +281,7 @@ Parse a clone id and get the role name part of it. -[getDhtOpAction(op)](./client.getdhtopaction.md) +[getChainOpAction(op)](./client.getchainopaction.md) @@ -291,7 +291,7 @@ Parse a clone id and get the role name part of it. -[getDhtOpEntry(op)](./client.getdhtopentry.md) +[getChainOpEntry(op)](./client.getchainopentry.md) @@ -301,7 +301,7 @@ Parse a clone id and get the role name part of it. -[getDhtOpSignature(op)](./client.getdhtopsignature.md) +[getChainOpSignature(op)](./client.getchainopsignature.md) @@ -311,7 +311,7 @@ Parse a clone id and get the role name part of it. -[getDhtOpType(op)](./client.getdhtoptype.md) +[getChainOpType(op)](./client.getchainoptype.md) diff --git a/package-lock.json b/package-lock.json index 53361a3b..9220e2dc 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@holochain/client", - "version": "0.18.0-rc.0", + "version": "0.18.0-rc.2", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@holochain/client", - "version": "0.18.0-rc.0", + "version": "0.18.0-rc.2", "license": "CAL-1.0", "dependencies": { "@bitgo/blake2b": "^3.2.4", diff --git a/package.json b/package.json index 4ae2d707..b8667c6b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@holochain/client", - "version": "0.18.0-rc.1", + "version": "0.18.0-rc.2", "description": "A JavaScript client for the Holochain Conductor API", "author": "Holochain Foundation (https://holochain.org)", "license": "CAL-1.0",