Docs setup (#5)

ceramicstudio · Apr 10, 2024 · bc1c3f7 · bc1c3f7
1 parent 91de0e4
commit bc1c3f7
Show file tree

Hide file tree

Showing 19 changed files with 1,591 additions and 358 deletions.
diff --git a/composites/points/composite.json b/composites/points/composite.json
diff --git a/composites/points/package.json b/composites/points/package.json
@@ -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"
   }
 }
diff --git a/composites/points/scripts/write-composite.ts b/composites/points/scripts/write-composite.ts
@@ -7,7 +7,7 @@ const PACKAGE_PATH = fileURLToPath(new URL('..', import.meta.url))
 await writeComposite({
   schemaPath: join(PACKAGE_PATH, 'schemas', '1-init.graphql'),
   compositeDefinitionPath: join(PACKAGE_PATH, 'composite.json'),
-  runtimeDefinitionPath: join(PACKAGE_PATH, 'src', 'index.ts'),
+  runtimeDefinitionPath: join(PACKAGE_PATH, 'src', 'definition.ts'),
 })
 
 process.exit(0)
diff --git a/composites/points/src/definition.ts b/composites/points/src/definition.ts
@@ -0,0 +1,129 @@
+// 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' },
+  },
+}
diff --git a/composites/points/src/index.ts b/composites/points/src/index.ts
@@ -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'
diff --git a/docs/api/README.md b/docs/api/README.md
@@ -0,0 +1,8 @@
+# Solutions SDK
+
+## Table of contents
+
+### Modules
+
+- [points](modules/points.md)
+- [points-composite](modules/points_composite.md)