Skip to content

Commit 3e49a66

Browse files
committed
chore: update docs
1 parent 280e70a commit 3e49a66

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+2364
-160
lines changed

docs/README.md

Lines changed: 7 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -19,26 +19,33 @@
1919
- [Actor](interfaces/Actor.md)
2020
- [AssertionDefinition](interfaces/AssertionDefinition.md)
2121
- [AssetType](interfaces/AssetType.md)
22+
- [BuilderInterface](interfaces/BuilderInterface.md)
23+
- [CallbackSignerInterface](interfaces/CallbackSignerInterface.md)
2224
- [ClaimGeneratorInfo](interfaces/ClaimGeneratorInfo.md)
2325
- [DataSource](interfaces/DataSource.md)
2426
- [DestinationBufferAsset](interfaces/DestinationBufferAsset.md)
2527
- [FileAsset](interfaces/FileAsset.md)
2628
- [HashedUri](interfaces/HashedUri.md)
29+
- [IdentityAssertionBuilderInterface](interfaces/IdentityAssertionBuilderInterface.md)
30+
- [IdentityAssertionSignerInterface](interfaces/IdentityAssertionSignerInterface.md)
2731
- [Ingredient](interfaces/Ingredient.md)
2832
- [IngredientOptions](interfaces/IngredientOptions.md)
2933
- [IngredientThumbnail](interfaces/IngredientThumbnail.md)
3034
- [JsCallbackSignerConfig](interfaces/JsCallbackSignerConfig.md)
35+
- [LocalSignerInterface](interfaces/LocalSignerInterface.md)
3136
- [Manifest](interfaces/Manifest.md)
3237
- [ManifestAssertion](interfaces/ManifestAssertion.md)
3338
- [ManifestDefinition](interfaces/ManifestDefinition.md)
3439
- [ManifestStore](interfaces/ManifestStore.md)
3540
- [Metadata](interfaces/Metadata.md)
41+
- [ReaderInterface](interfaces/ReaderInterface.md)
3642
- [ResourceRef](interfaces/ResourceRef.md)
3743
- [ResourceStore](interfaces/ResourceStore.md)
3844
- [ReviewRating](interfaces/ReviewRating.md)
3945
- [SignatureInfo](interfaces/SignatureInfo.md)
4046
- [SourceBufferAsset](interfaces/SourceBufferAsset.md)
4147
- [TrustmarkConfig](interfaces/TrustmarkConfig.md)
48+
- [TrustmarkInterface](interfaces/TrustmarkInterface.md)
4249
- [ValidationStatus](interfaces/ValidationStatus.md)
4350

4451
## Type Aliases
@@ -54,49 +61,3 @@
5461
- [TrustmarkVariant](type-aliases/TrustmarkVariant.md)
5562
- [TrustmarkVersion](type-aliases/TrustmarkVersion.md)
5663
- [UriOrResource](type-aliases/UriOrResource.md)
57-
58-
## Functions
59-
60-
- [builderAddAssertion](functions/builderAddAssertion.md)
61-
- [builderAddIngredient](functions/builderAddIngredient.md)
62-
- [builderAddResource](functions/builderAddResource.md)
63-
- [builderFromArchive](functions/builderFromArchive.md)
64-
- [builderIdentitySignAsync](functions/builderIdentitySignAsync.md)
65-
- [builderManifestDefinition](functions/builderManifestDefinition.md)
66-
- [builderNew](functions/builderNew.md)
67-
- [builderSetNoEmbed](functions/builderSetNoEmbed.md)
68-
- [builderSetRemoteUrl](functions/builderSetRemoteUrl.md)
69-
- [builderSign](functions/builderSign.md)
70-
- [builderSignAsync](functions/builderSignAsync.md)
71-
- [builderSignConfigAsync](functions/builderSignConfigAsync.md)
72-
- [builderToArchive](functions/builderToArchive.md)
73-
- [builderUpdateManifestProperty](functions/builderUpdateManifestProperty.md)
74-
- [builderWithJson](functions/builderWithJson.md)
75-
- [callbackSignerAlg](functions/callbackSignerAlg.md)
76-
- [callbackSignerCerts](functions/callbackSignerCerts.md)
77-
- [callbackSignerConfigFromJs](functions/callbackSignerConfigFromJs.md)
78-
- [callbackSignerFromConfig](functions/callbackSignerFromConfig.md)
79-
- [callbackSignerReserveSize](functions/callbackSignerReserveSize.md)
80-
- [callbackSignerSign](functions/callbackSignerSign.md)
81-
- [callbackSignerTimeAuthorityUrl](functions/callbackSignerTimeAuthorityUrl.md)
82-
- [identityBuilderAddReferencedAssertions](functions/identityBuilderAddReferencedAssertions.md)
83-
- [identityBuilderAddRoles](functions/identityBuilderAddRoles.md)
84-
- [identityBuilderForCredentialHolder](functions/identityBuilderForCredentialHolder.md)
85-
- [identitySignerAddIdentityAssertion](functions/identitySignerAddIdentityAssertion.md)
86-
- [identitySignerNew](functions/identitySignerNew.md)
87-
- [localSignerAlg](functions/localSignerAlg.md)
88-
- [localSignerCerts](functions/localSignerCerts.md)
89-
- [localSignerNew](functions/localSignerNew.md)
90-
- [localSignerReserveSize](functions/localSignerReserveSize.md)
91-
- [localSignerSign](functions/localSignerSign.md)
92-
- [localSignerTimeAuthorityUrl](functions/localSignerTimeAuthorityUrl.md)
93-
- [readerFromAsset](functions/readerFromAsset.md)
94-
- [readerFromManifestDataAndAsset](functions/readerFromManifestDataAndAsset.md)
95-
- [readerIsEmbedded](functions/readerIsEmbedded.md)
96-
- [readerJson](functions/readerJson.md)
97-
- [readerPostValidateCawg](functions/readerPostValidateCawg.md)
98-
- [readerRemoteUrl](functions/readerRemoteUrl.md)
99-
- [readerResourceToAsset](functions/readerResourceToAsset.md)
100-
- [trustmarkDecode](functions/trustmarkDecode.md)
101-
- [trustmarkEncode](functions/trustmarkEncode.md)
102-
- [trustmarkNew](functions/trustmarkNew.md)

docs/classes/Builder.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,19 @@
66

77
# Class: Builder
88

9-
Defined in: [Builder.ts:17](https://github.com/contentauth/c2pa-node-v2/blob/1df68df861d38a8c4eb7c634a613532727ec72d3/js-src/Builder.ts#L17)
9+
Defined in: [Builder.ts:29](https://github.com/contentauth/c2pa-node-v2/blob/280e70a4878b95c480efb475988df1206fe5da39/js-src/Builder.ts#L29)
1010

1111
## Implements
1212

13-
- `Builder`
13+
- [`BuilderInterface`](../interfaces/BuilderInterface.md)
1414

1515
## Methods
1616

1717
### addAssertion()
1818

1919
> **addAssertion**(`label`, `assertion`, `assertionKind?`): `void`
2020
21-
Defined in: [Builder.ts:52](https://github.com/contentauth/c2pa-node-v2/blob/1df68df861d38a8c4eb7c634a613532727ec72d3/js-src/Builder.ts#L52)
21+
Defined in: [Builder.ts:64](https://github.com/contentauth/c2pa-node-v2/blob/280e70a4878b95c480efb475988df1206fe5da39/js-src/Builder.ts#L64)
2222

2323
Add CBOR assertion to the builder
2424

@@ -46,15 +46,15 @@ The CBOR encoded assertion
4646

4747
#### Implementation of
4848

49-
`neon.Builder.addAssertion`
49+
[`BuilderInterface`](../interfaces/BuilderInterface.md).[`addAssertion`](../interfaces/BuilderInterface.md#addassertion)
5050

5151
***
5252

5353
### addIngredient()
5454

5555
> **addIngredient**(`ingredientJson`, `ingredient`): `Promise`\<`void`\>
5656
57-
Defined in: [Builder.ts:69](https://github.com/contentauth/c2pa-node-v2/blob/1df68df861d38a8c4eb7c634a613532727ec72d3/js-src/Builder.ts#L69)
57+
Defined in: [Builder.ts:81](https://github.com/contentauth/c2pa-node-v2/blob/280e70a4878b95c480efb475988df1206fe5da39/js-src/Builder.ts#L81)
5858

5959
Add an ingredient from a buffer or file
6060

@@ -78,15 +78,15 @@ The source and format of the ingredient
7878

7979
#### Implementation of
8080

81-
`neon.Builder.addIngredient`
81+
[`BuilderInterface`](../interfaces/BuilderInterface.md).[`addIngredient`](../interfaces/BuilderInterface.md#addingredient)
8282

8383
***
8484

8585
### addResource()
8686

8787
> **addResource**(`uri`, `resource`): `Promise`\<`void`\>
8888
89-
Defined in: [Builder.ts:65](https://github.com/contentauth/c2pa-node-v2/blob/1df68df861d38a8c4eb7c634a613532727ec72d3/js-src/Builder.ts#L65)
89+
Defined in: [Builder.ts:77](https://github.com/contentauth/c2pa-node-v2/blob/280e70a4878b95c480efb475988df1206fe5da39/js-src/Builder.ts#L77)
9090

9191
Add a resource from a buffer or file
9292

@@ -110,15 +110,15 @@ The source and format of the resource
110110

111111
#### Implementation of
112112

113-
`neon.Builder.addResource`
113+
[`BuilderInterface`](../interfaces/BuilderInterface.md).[`addResource`](../interfaces/BuilderInterface.md#addresource)
114114

115115
***
116116

117117
### getManifestDefinition()
118118

119119
> **getManifestDefinition**(): [`ManifestDefinition`](../interfaces/ManifestDefinition.md)
120120
121-
Defined in: [Builder.ts:184](https://github.com/contentauth/c2pa-node-v2/blob/1df68df861d38a8c4eb7c634a613532727ec72d3/js-src/Builder.ts#L184)
121+
Defined in: [Builder.ts:196](https://github.com/contentauth/c2pa-node-v2/blob/280e70a4878b95c480efb475988df1206fe5da39/js-src/Builder.ts#L196)
122122

123123
Getter for the builder's manifest definition
124124

@@ -130,15 +130,15 @@ The manifest definition
130130

131131
#### Implementation of
132132

133-
`neon.Builder.getManifestDefinition`
133+
[`BuilderInterface`](../interfaces/BuilderInterface.md).[`getManifestDefinition`](../interfaces/BuilderInterface.md#getmanifestdefinition)
134134

135135
***
136136

137137
### identitySignAsync()
138138

139139
> **identitySignAsync**(`signer`, `input`, `output`): `Promise`\<`Buffer`\<`ArrayBufferLike`\>\>
140140
141-
Defined in: [Builder.ts:158](https://github.com/contentauth/c2pa-node-v2/blob/1df68df861d38a8c4eb7c634a613532727ec72d3/js-src/Builder.ts#L158)
141+
Defined in: [Builder.ts:170](https://github.com/contentauth/c2pa-node-v2/blob/280e70a4878b95c480efb475988df1206fe5da39/js-src/Builder.ts#L170)
142142

143143
Sign an asset from a buffer or file asynchronously, using an
144144
IdentityAssertionSigner
@@ -167,15 +167,15 @@ the bytes of the c2pa_manifest that was embedded
167167

168168
#### Implementation of
169169

170-
`neon.Builder.identitySignAsync`
170+
[`BuilderInterface`](../interfaces/BuilderInterface.md).[`identitySignAsync`](../interfaces/BuilderInterface.md#identitysignasync)
171171

172172
***
173173

174174
### setNoEmbed()
175175

176176
> **setNoEmbed**(`noEmbed`): `void`
177177
178-
Defined in: [Builder.ts:44](https://github.com/contentauth/c2pa-node-v2/blob/1df68df861d38a8c4eb7c634a613532727ec72d3/js-src/Builder.ts#L44)
178+
Defined in: [Builder.ts:56](https://github.com/contentauth/c2pa-node-v2/blob/280e70a4878b95c480efb475988df1206fe5da39/js-src/Builder.ts#L56)
179179

180180
Set the no embed flag of the manifest
181181

@@ -193,15 +193,15 @@ The no embed flag of the manifest
193193

194194
#### Implementation of
195195

196-
`neon.Builder.setNoEmbed`
196+
[`BuilderInterface`](../interfaces/BuilderInterface.md).[`setNoEmbed`](../interfaces/BuilderInterface.md#setnoembed)
197197

198198
***
199199

200200
### setRemoteUrl()
201201

202202
> **setRemoteUrl**(`remoteUrl`): `void`
203203
204-
Defined in: [Builder.ts:48](https://github.com/contentauth/c2pa-node-v2/blob/1df68df861d38a8c4eb7c634a613532727ec72d3/js-src/Builder.ts#L48)
204+
Defined in: [Builder.ts:60](https://github.com/contentauth/c2pa-node-v2/blob/280e70a4878b95c480efb475988df1206fe5da39/js-src/Builder.ts#L60)
205205

206206
Set the remote URL of the manifest
207207

@@ -217,23 +217,23 @@ Set the remote URL of the manifest
217217

218218
#### Implementation of
219219

220-
`neon.Builder.setRemoteUrl`
220+
[`BuilderInterface`](../interfaces/BuilderInterface.md).[`setRemoteUrl`](../interfaces/BuilderInterface.md#setremoteurl)
221221

222222
***
223223

224224
### sign()
225225

226226
> **sign**(`signer`, `input`, `output`): `Buffer`
227227
228-
Defined in: [Builder.ts:88](https://github.com/contentauth/c2pa-node-v2/blob/1df68df861d38a8c4eb7c634a613532727ec72d3/js-src/Builder.ts#L88)
228+
Defined in: [Builder.ts:100](https://github.com/contentauth/c2pa-node-v2/blob/280e70a4878b95c480efb475988df1206fe5da39/js-src/Builder.ts#L100)
229229

230230
Sign an asset from a buffer or file
231231

232232
#### Parameters
233233

234234
##### signer
235235

236-
[`LocalSigner`](LocalSigner.md)
236+
[`LocalSignerInterface`](../interfaces/LocalSignerInterface.md)
237237

238238
The local signer to use
239239

@@ -253,15 +253,15 @@ the bytes of the c2pa_manifest that was embedded
253253

254254
#### Implementation of
255255

256-
`neon.Builder.sign`
256+
[`BuilderInterface`](../interfaces/BuilderInterface.md).[`sign`](../interfaces/BuilderInterface.md#sign)
257257

258258
***
259259

260260
### signAsync()
261261

262262
> **signAsync**(`signer`, `input`, `output`): `Promise`\<`Buffer`\<`ArrayBufferLike`\>\>
263263
264-
Defined in: [Builder.ts:132](https://github.com/contentauth/c2pa-node-v2/blob/1df68df861d38a8c4eb7c634a613532727ec72d3/js-src/Builder.ts#L132)
264+
Defined in: [Builder.ts:144](https://github.com/contentauth/c2pa-node-v2/blob/280e70a4878b95c480efb475988df1206fe5da39/js-src/Builder.ts#L144)
265265

266266
Sign an asset from a buffer or file asynchronously, using a
267267
CallbackSigner
@@ -270,7 +270,7 @@ CallbackSigner
270270

271271
##### signer
272272

273-
[`CallbackSigner`](CallbackSigner.md)
273+
[`CallbackSignerInterface`](../interfaces/CallbackSignerInterface.md)
274274

275275
##### input
276276

@@ -288,15 +288,15 @@ the bytes of the c2pa_manifest that was embedded
288288

289289
#### Implementation of
290290

291-
`neon.Builder.signAsync`
291+
[`BuilderInterface`](../interfaces/BuilderInterface.md).[`signAsync`](../interfaces/BuilderInterface.md#signasync)
292292

293293
***
294294

295295
### signConfigAsync()
296296

297297
> **signConfigAsync**(`callback`, `signerConfig`, `input`, `output`): `Promise`\<`Buffer`\<`ArrayBufferLike`\>\>
298298
299-
Defined in: [Builder.ts:105](https://github.com/contentauth/c2pa-node-v2/blob/1df68df861d38a8c4eb7c634a613532727ec72d3/js-src/Builder.ts#L105)
299+
Defined in: [Builder.ts:117](https://github.com/contentauth/c2pa-node-v2/blob/280e70a4878b95c480efb475988df1206fe5da39/js-src/Builder.ts#L117)
300300

301301
Sign an asset from a buffer or file asynchronously, using a callback
302302
and not passing a private key
@@ -331,23 +331,23 @@ the bytes of the c2pa_manifest that was embedded
331331

332332
#### Implementation of
333333

334-
`neon.Builder.signConfigAsync`
334+
[`BuilderInterface`](../interfaces/BuilderInterface.md).[`signConfigAsync`](../interfaces/BuilderInterface.md#signconfigasync)
335335

336336
***
337337

338338
### signFile()
339339

340340
> **signFile**(`signer`, `filePath`, `output`): `Buffer`
341341
342-
Defined in: [Builder.ts:96](https://github.com/contentauth/c2pa-node-v2/blob/1df68df861d38a8c4eb7c634a613532727ec72d3/js-src/Builder.ts#L96)
342+
Defined in: [Builder.ts:108](https://github.com/contentauth/c2pa-node-v2/blob/280e70a4878b95c480efb475988df1206fe5da39/js-src/Builder.ts#L108)
343343

344344
Embed a signed manifest into a stream using the LocalSigner
345345

346346
#### Parameters
347347

348348
##### signer
349349

350-
[`LocalSigner`](LocalSigner.md)
350+
[`LocalSignerInterface`](../interfaces/LocalSignerInterface.md)
351351

352352
The local signer to use
353353

@@ -367,15 +367,15 @@ the bytes of the c2pa_manifest that was embedded
367367

368368
#### Implementation of
369369

370-
`neon.Builder.signFile`
370+
[`BuilderInterface`](../interfaces/BuilderInterface.md).[`signFile`](../interfaces/BuilderInterface.md#signfile)
371371

372372
***
373373

374374
### toArchive()
375375

376376
> **toArchive**(`asset`): `Promise`\<`void`\>
377377
378-
Defined in: [Builder.ts:80](https://github.com/contentauth/c2pa-node-v2/blob/1df68df861d38a8c4eb7c634a613532727ec72d3/js-src/Builder.ts#L80)
378+
Defined in: [Builder.ts:92](https://github.com/contentauth/c2pa-node-v2/blob/280e70a4878b95c480efb475988df1206fe5da39/js-src/Builder.ts#L92)
379379

380380
Convert the Builder into a archive formatted buffer or file
381381

@@ -393,15 +393,15 @@ The file or buffer for the archive
393393

394394
#### Implementation of
395395

396-
`neon.Builder.toArchive`
396+
[`BuilderInterface`](../interfaces/BuilderInterface.md).[`toArchive`](../interfaces/BuilderInterface.md#toarchive)
397397

398398
***
399399

400400
### updateManifestProperty()
401401

402402
> **updateManifestProperty**(`property`, `value`): `void`
403403
404-
Defined in: [Builder.ts:188](https://github.com/contentauth/c2pa-node-v2/blob/1df68df861d38a8c4eb7c634a613532727ec72d3/js-src/Builder.ts#L188)
404+
Defined in: [Builder.ts:200](https://github.com/contentauth/c2pa-node-v2/blob/280e70a4878b95c480efb475988df1206fe5da39/js-src/Builder.ts#L200)
405405

406406
Update a string property of the manifest
407407

@@ -423,15 +423,15 @@ The manifest definition
423423

424424
#### Implementation of
425425

426-
`neon.Builder.updateManifestProperty`
426+
[`BuilderInterface`](../interfaces/BuilderInterface.md).[`updateManifestProperty`](../interfaces/BuilderInterface.md#updatemanifestproperty)
427427

428428
***
429429

430430
### fromArchive()
431431

432432
> `static` **fromArchive**(`asset`): `Promise`\<`Builder`\>
433433
434-
Defined in: [Builder.ts:84](https://github.com/contentauth/c2pa-node-v2/blob/1df68df861d38a8c4eb7c634a613532727ec72d3/js-src/Builder.ts#L84)
434+
Defined in: [Builder.ts:96](https://github.com/contentauth/c2pa-node-v2/blob/280e70a4878b95c480efb475988df1206fe5da39/js-src/Builder.ts#L96)
435435

436436
#### Parameters
437437

@@ -449,7 +449,7 @@ Defined in: [Builder.ts:84](https://github.com/contentauth/c2pa-node-v2/blob/1df
449449

450450
> `static` **new**(): `Builder`
451451
452-
Defined in: [Builder.ts:20](https://github.com/contentauth/c2pa-node-v2/blob/1df68df861d38a8c4eb7c634a613532727ec72d3/js-src/Builder.ts#L20)
452+
Defined in: [Builder.ts:32](https://github.com/contentauth/c2pa-node-v2/blob/280e70a4878b95c480efb475988df1206fe5da39/js-src/Builder.ts#L32)
453453

454454
#### Returns
455455

@@ -461,7 +461,7 @@ Defined in: [Builder.ts:20](https://github.com/contentauth/c2pa-node-v2/blob/1df
461461

462462
> `static` **withJson**(`json`): `Builder`
463463
464-
Defined in: [Builder.ts:25](https://github.com/contentauth/c2pa-node-v2/blob/1df68df861d38a8c4eb7c634a613532727ec72d3/js-src/Builder.ts#L25)
464+
Defined in: [Builder.ts:37](https://github.com/contentauth/c2pa-node-v2/blob/280e70a4878b95c480efb475988df1206fe5da39/js-src/Builder.ts#L37)
465465

466466
#### Parameters
467467

0 commit comments

Comments
 (0)