Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(release): v0.18.0-rc.2 #310

Merged
merged 2 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
24 changes: 14 additions & 10 deletions docs/client.chainop.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

6 changes: 3 additions & 3 deletions docs/client.dhtoptype.md → docs/client.chainoptype.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [DhtOpType](./client.dhtoptype.md)
[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [ChainOpType](./client.chainoptype.md)

## DhtOpType enum
## ChainOpType enum


**Signature:**

```typescript
export declare enum DhtOpType
export declare enum ChainOpType
```

## Enumeration Members
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [getDhtOpAction](./client.getdhtopaction.md)
[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [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
Expand Down Expand Up @@ -36,7 +36,7 @@ op

</td><td>

[DhtOp](./client.dhtop.md)
[ChainOp](./client.chainop.md)


</td><td>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [getDhtOpEntry](./client.getdhtopentry.md)
[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [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
Expand Down Expand Up @@ -36,7 +36,7 @@ op

</td><td>

[DhtOp](./client.dhtop.md)
[ChainOp](./client.chainop.md)


</td><td>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [getDhtOpSignature](./client.getdhtopsignature.md)
[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [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
Expand Down Expand Up @@ -36,7 +36,7 @@ op

</td><td>

[DhtOp](./client.dhtop.md)
[ChainOp](./client.chainop.md)


</td><td>
Expand Down
10 changes: 5 additions & 5 deletions docs/client.getdhtoptype.md → docs/client.getchainoptype.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [getDhtOpType](./client.getdhtoptype.md)
[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [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
Expand Down Expand Up @@ -36,7 +36,7 @@ op

</td><td>

[DhtOp](./client.dhtop.md)
[ChainOp](./client.chainop.md)


</td><td>
Expand All @@ -46,5 +46,5 @@ op
</tbody></table>
**Returns:**

[DhtOpType](./client.dhtoptype.md)
[ChainOpType](./client.chainoptype.md)

10 changes: 5 additions & 5 deletions docs/client.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ Description
</td></tr>
<tr><td>

[DhtOpType](./client.dhtoptype.md)
[ChainOpType](./client.chainoptype.md)


</td><td>
Expand Down Expand Up @@ -281,7 +281,7 @@ Parse a clone id and get the role name part of it.
</td></tr>
<tr><td>

[getDhtOpAction(op)](./client.getdhtopaction.md)
[getChainOpAction(op)](./client.getchainopaction.md)


</td><td>
Expand All @@ -291,7 +291,7 @@ Parse a clone id and get the role name part of it.
</td></tr>
<tr><td>

[getDhtOpEntry(op)](./client.getdhtopentry.md)
[getChainOpEntry(op)](./client.getchainopentry.md)


</td><td>
Expand All @@ -301,7 +301,7 @@ Parse a clone id and get the role name part of it.
</td></tr>
<tr><td>

[getDhtOpSignature(op)](./client.getdhtopsignature.md)
[getChainOpSignature(op)](./client.getchainopsignature.md)


</td><td>
Expand All @@ -311,7 +311,7 @@ Parse a clone id and get the role name part of it.
</td></tr>
<tr><td>

[getDhtOpType(op)](./client.getdhtoptype.md)
[getChainOpType(op)](./client.getchainoptype.md)


</td><td>
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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 <[email protected]> (https://holochain.org)",
"license": "CAL-1.0",
Expand Down
Loading