Skip to content

Commit

Permalink
Update generated docs with new APIs
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Le Cam committed Apr 10, 2024
1 parent 63cb3ad commit 9500147
Show file tree
Hide file tree
Showing 13 changed files with 362 additions and 411 deletions.
2 changes: 1 addition & 1 deletion composites/points/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
"devDependencies": {
"@composedb/types": "^0.7.1",
"@composexp/composite-utils": "workspace:^",
"@types/node": "^20.12.5",
"@types/node": "^20.12.7",
"tsx": "^4.7.2"
}
}
134 changes: 5 additions & 129 deletions composites/points/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,129 +1,5 @@
// This is an auto-generated file, do not edit manually
import type { RuntimeCompositeDefinition } from '@composedb/types'
export const definition: RuntimeCompositeDefinition = {
models: {
GenericPointAllocation: {
interface: true,
implements: [],
id: 'kjzl6hvfrbw6c6m3n64vb2h4n8nxq9jjfb7sf7a9y893spm1pjd0enrsdlyphg4',
accountRelation: { type: 'none' },
},
MultiplePoints: {
interface: false,
implements: [
'kjzl6hvfrbw6ca7buvthejhv7vqr85vmpsepzj0mc6665y2zarvjbuvtm3v4kah',
'kjzl6hvfrbw6c6m3n64vb2h4n8nxq9jjfb7sf7a9y893spm1pjd0enrsdlyphg4',
],
id: 'kjzl6hvfrbw6c9fmjjdsbuxnewf0yhvco3dn5mihiogeso6i1csdbw2fq8oeijy',
accountRelation: { type: 'list' },
},
MultiplePointsAllocation: {
interface: true,
implements: ['kjzl6hvfrbw6c6m3n64vb2h4n8nxq9jjfb7sf7a9y893spm1pjd0enrsdlyphg4'],
id: 'kjzl6hvfrbw6ca7buvthejhv7vqr85vmpsepzj0mc6665y2zarvjbuvtm3v4kah',
accountRelation: { type: 'none' },
},
PointsAggregation: {
interface: true,
implements: [],
id: 'kjzl6hvfrbw6cb6393dpd8blke5w8r7pvbl4449mxetuibcav3oab8fnxmys6d6',
accountRelation: { type: 'none' },
},
SinglePoint: {
interface: false,
implements: [
'kjzl6hvfrbw6c7ilzfpjw96drd04jadb0aybiklk70ys2imxp5mjbjmgkecgddf',
'kjzl6hvfrbw6c6m3n64vb2h4n8nxq9jjfb7sf7a9y893spm1pjd0enrsdlyphg4',
],
id: 'kjzl6hvfrbw6c9332q9di7qfshxczet94w2tzeubvkbkk9vtuwmya6s9f1bvx9p',
accountRelation: { type: 'list' },
},
SinglePointAllocation: {
interface: true,
implements: ['kjzl6hvfrbw6c6m3n64vb2h4n8nxq9jjfb7sf7a9y893spm1pjd0enrsdlyphg4'],
id: 'kjzl6hvfrbw6c7ilzfpjw96drd04jadb0aybiklk70ys2imxp5mjbjmgkecgddf',
accountRelation: { type: 'none' },
},
TotalPoints: {
interface: false,
implements: ['kjzl6hvfrbw6cb6393dpd8blke5w8r7pvbl4449mxetuibcav3oab8fnxmys6d6'],
id: 'kjzl6hvfrbw6c5be4exsm7nkkksnqatki8bceyvbgtmcu2bu5vign23b7x4emlb',
accountRelation: { type: 'set', fields: ['recipient'] },
},
},
objects: {
GenericPointAllocation: {
recipient: { type: 'did', required: true, immutable: false },
issuer: { type: 'view', viewType: 'documentAccount' },
},
MultiplePoints: {
points: { type: 'integer', required: true, immutable: false },
recipient: { type: 'did', required: true, immutable: false },
issuer: { type: 'view', viewType: 'documentAccount' },
},
MultiplePointsAllocation: {
points: { type: 'integer', required: true, immutable: false },
recipient: { type: 'did', required: true, immutable: false },
issuer: { type: 'view', viewType: 'documentAccount' },
},
PointsAggregation: {
date: { type: 'datetime', required: true, immutable: false },
points: { type: 'integer', required: true, immutable: false },
recipient: { type: 'did', required: true, immutable: false },
issuer: { type: 'view', viewType: 'documentAccount' },
},
SinglePoint: {
recipient: { type: 'did', required: true, immutable: false },
issuer: { type: 'view', viewType: 'documentAccount' },
},
SinglePointAllocation: {
recipient: { type: 'did', required: true, immutable: false },
issuer: { type: 'view', viewType: 'documentAccount' },
},
TotalPoints: {
date: { type: 'datetime', required: true, immutable: false },
points: { type: 'integer', required: true, immutable: false },
recipient: { type: 'did', required: true, immutable: true },
issuer: { type: 'view', viewType: 'documentAccount' },
},
},
enums: {},
accountData: {
genericPointAllocationList: { type: 'connection', name: 'GenericPointAllocation' },
multiplePointsAllocationList: { type: 'connection', name: 'MultiplePointsAllocation' },
multiplePointsList: { type: 'connection', name: 'MultiplePoints' },
pointsAggregationList: { type: 'connection', name: 'PointsAggregation' },
recipientOfGenericPointAllocationList: {
type: 'account',
name: 'GenericPointAllocation',
property: 'recipient',
},
recipientOfMultiplePointsAllocationList: {
type: 'account',
name: 'MultiplePointsAllocation',
property: 'recipient',
},
recipientOfMultiplePointsList: {
type: 'account',
name: 'MultiplePoints',
property: 'recipient',
},
recipientOfPointsAggregationList: {
type: 'account',
name: 'PointsAggregation',
property: 'recipient',
},
recipientOfSinglePointAllocationList: {
type: 'account',
name: 'SinglePointAllocation',
property: 'recipient',
},
recipientOfSinglePointList: { type: 'account', name: 'SinglePoint', property: 'recipient' },
recipientOfTotalPoints: { type: 'account-set', name: 'TotalPoints', property: 'recipient' },
recipientOfTotalPointsList: { type: 'account', name: 'TotalPoints', property: 'recipient' },
singlePointAllocationList: { type: 'connection', name: 'SinglePointAllocation' },
singlePointList: { type: 'connection', name: 'SinglePoint' },
totalPoints: { type: 'set', name: 'TotalPoints' },
totalPointsList: { type: 'connection', name: 'TotalPoints' },
},
}
/**
* @module points-composite
*/

export { definition } from './definition.js'
48 changes: 35 additions & 13 deletions docs/api/classes/points.PointsReader.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@

- [getAggregationPointsFor](points.PointsReader.md#getaggregationpointsfor)
- [loadAggregationDocumentFor](points.PointsReader.md#loadaggregationdocumentfor)
- [loadAggregationDocumentsFor](points.PointsReader.md#loadaggregationdocumentsfor)
- [queryAggregationDocuments](points.PointsReader.md#queryaggregationdocuments)
- [queryAllocationDocumentsFor](points.PointsReader.md#queryallocationdocumentsfor)

Expand Down Expand Up @@ -60,7 +61,7 @@

#### Defined in

[libraries/points/src/points-reader.ts:41](https://github.com/ceramicstudio/solutions/blob/a751967/libraries/points/src/points-reader.ts#L41)
[libraries/points/src/points-reader.ts:45](https://github.com/ceramicstudio/solutions/blob/63cb3ad5f3da236446973238558e1895a955200e/libraries/points/src/points-reader.ts#L45)

## Accessors

Expand All @@ -74,7 +75,7 @@

#### Defined in

[libraries/points/src/points-reader.ts:55](https://github.com/ceramicstudio/solutions/blob/a751967/libraries/points/src/points-reader.ts#L55)
[libraries/points/src/points-reader.ts:59](https://github.com/ceramicstudio/solutions/blob/63cb3ad5f3da236446973238558e1895a955200e/libraries/points/src/points-reader.ts#L59)

___

Expand All @@ -88,7 +89,7 @@ ___

#### Defined in

[libraries/points/src/points-reader.ts:59](https://github.com/ceramicstudio/solutions/blob/a751967/libraries/points/src/points-reader.ts#L59)
[libraries/points/src/points-reader.ts:63](https://github.com/ceramicstudio/solutions/blob/63cb3ad5f3da236446973238558e1895a955200e/libraries/points/src/points-reader.ts#L63)

___

Expand All @@ -102,7 +103,7 @@ ___

#### Defined in

[libraries/points/src/points-reader.ts:63](https://github.com/ceramicstudio/solutions/blob/a751967/libraries/points/src/points-reader.ts#L63)
[libraries/points/src/points-reader.ts:67](https://github.com/ceramicstudio/solutions/blob/63cb3ad5f3da236446973238558e1895a955200e/libraries/points/src/points-reader.ts#L67)

___

Expand All @@ -116,39 +117,39 @@ ___

#### Defined in

[libraries/points/src/points-reader.ts:67](https://github.com/ceramicstudio/solutions/blob/a751967/libraries/points/src/points-reader.ts#L67)
[libraries/points/src/points-reader.ts:71](https://github.com/ceramicstudio/solutions/blob/63cb3ad5f3da236446973238558e1895a955200e/libraries/points/src/points-reader.ts#L71)

## Methods

### getAggregationPointsFor

**getAggregationPointsFor**(`did`): `Promise`\<`number`\>
**getAggregationPointsFor**(`didOrValues`): `Promise`\<`number`\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `did` | `string` |
| `didOrValues` | `string` \| `string`[] |

#### Returns

`Promise`\<`number`\>

#### Defined in

[libraries/points/src/points-reader.ts:81](https://github.com/ceramicstudio/solutions/blob/a751967/libraries/points/src/points-reader.ts#L81)
[libraries/points/src/points-reader.ts:95](https://github.com/ceramicstudio/solutions/blob/63cb3ad5f3da236446973238558e1895a955200e/libraries/points/src/points-reader.ts#L95)

___

### loadAggregationDocumentFor

**loadAggregationDocumentFor**(`did`, `options?`): `Promise`\<``null`` \| `ModelInstanceDocument`\<`AggregationContent`\>\>
**loadAggregationDocumentFor**(`didOrValues`, `options?`): `Promise`\<``null`` \| `ModelInstanceDocument`\<`AggregationContent`\>\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `did` | `string` |
| `didOrValues` | `string` \| `string`[] |
| `options` | `DeterministicLoadOptions` |

#### Returns
Expand All @@ -157,7 +158,28 @@ ___

#### Defined in

[libraries/points/src/points-reader.ts:71](https://github.com/ceramicstudio/solutions/blob/a751967/libraries/points/src/points-reader.ts#L71)
[libraries/points/src/points-reader.ts:75](https://github.com/ceramicstudio/solutions/blob/63cb3ad5f3da236446973238558e1895a955200e/libraries/points/src/points-reader.ts#L75)

___

### loadAggregationDocumentsFor

**loadAggregationDocumentsFor**(`did`, `options?`): `Promise`\<[`QueryDocumentsResult`](../modules/points.md#querydocumentsresult)\<`AggregationContent`\>\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `did` | `string` |
| `options?` | [`QueryDocumentsOptions`](../modules/points.md#querydocumentsoptions) |

#### Returns

`Promise`\<[`QueryDocumentsResult`](../modules/points.md#querydocumentsresult)\<`AggregationContent`\>\>

#### Defined in

[libraries/points/src/points-reader.ts:87](https://github.com/ceramicstudio/solutions/blob/63cb3ad5f3da236446973238558e1895a955200e/libraries/points/src/points-reader.ts#L87)

___

Expand All @@ -177,7 +199,7 @@ ___

#### Defined in

[libraries/points/src/points-reader.ts:86](https://github.com/ceramicstudio/solutions/blob/a751967/libraries/points/src/points-reader.ts#L86)
[libraries/points/src/points-reader.ts:100](https://github.com/ceramicstudio/solutions/blob/63cb3ad5f3da236446973238558e1895a955200e/libraries/points/src/points-reader.ts#L100)

___

Expand All @@ -198,4 +220,4 @@ ___

#### Defined in

[libraries/points/src/points-reader.ts:92](https://github.com/ceramicstudio/solutions/blob/a751967/libraries/points/src/points-reader.ts#L92)
[libraries/points/src/points-reader.ts:106](https://github.com/ceramicstudio/solutions/blob/63cb3ad5f3da236446973238558e1895a955200e/libraries/points/src/points-reader.ts#L106)
Loading

0 comments on commit 9500147

Please sign in to comment.