fix: [temp] skip stonecrop api extraction

agritheory · Dec 13, 2024 · e9a06f5 · e9a06f5
1 parent 92b13b0
commit e9a06f5
Show file tree

Hide file tree

Showing 25 changed files with 336 additions and 30 deletions.
diff --git a/aform/package.json b/aform/package.json
@@ -48,7 +48,7 @@
 		"vue": "^3.5.11"
 	},
 	"devDependencies": {
-		"@microsoft/api-documenter": "^7.25.3",
+		"@microsoft/api-documenter": "^7.26.2",
 		"@rushstack/heft": "^0.68.6",
 		"@stonecrop/atable": "workspace:*",
 		"@typescript-eslint/eslint-plugin": "^7.14.1",

diff --git a/atable/package.json b/atable/package.json
@@ -53,7 +53,7 @@
 		"vue": "^3.5.11"
 	},
 	"devDependencies": {
-		"@microsoft/api-documenter": "^7.25.3",
+		"@microsoft/api-documenter": "^7.26.2",
 		"@rushstack/heft": "^0.68.6",
 		"@typescript-eslint/eslint-plugin": "^7.14.1",
 		"@typescript-eslint/parser": "^7.14.1",

diff --git a/beam/package.json b/beam/package.json
@@ -46,7 +46,7 @@
 		"vue": "^3.5.11"
 	},
 	"devDependencies": {
-		"@microsoft/api-documenter": "^7.25.3",
+		"@microsoft/api-documenter": "^7.26.2",
 		"@rushstack/heft": "^0.68.6",
 		"@typescript-eslint/eslint-plugin": "^7.14.1",
 		"@typescript-eslint/parser": "^7.14.1",

diff --git a/code_editor/package.json b/code_editor/package.json
@@ -41,7 +41,7 @@
 		"vue": "^3.5.11"
 	},
 	"devDependencies": {
-		"@microsoft/api-documenter": "^7.25.3",
+		"@microsoft/api-documenter": "^7.26.2",
 		"@rushstack/heft": "^0.68.6",
 		"@stonecrop/atable": "workspace:*",
 		"@typescript-eslint/eslint-plugin": "^7.14.1",

diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml
diff --git a/common/reviews/api/desktop.api.md b/common/reviews/api/desktop.api.md
@@ -5,11 +5,12 @@
 ```ts
 
 import ActionSet from '@/components/ActionSet.vue';
+import { App } from 'vue';
 import CommandPalette from '@/components/CommandPalette.vue';
 import Doctype from '@/components/Doctype.vue';
+import { Plugin as Plugin_2 } from 'vue';
 import Records from '@/components/Records.vue';
 import SheetNav from '@/components/SheetNav.vue';
-import StonecropDesktop from '@/plugins';
 
 export { ActionSet }
 
@@ -21,7 +22,16 @@ export { Records }
 
 export { SheetNav }
 
-export { StonecropDesktop }
+// @public
+export const StonecropDesktop: Plugin_2 = {
+    	install: (app: App) => {
+        		app.component('ActionSet', ActionSet)
+        		app.component('CommandPalette', CommandPalette)
+        		app.component('Doctype', Doctype)
+        		app.component('Records', Records)
+        		app.component('SheetNav', SheetNav)
+        	},
+};
 
 // (No @packageDocumentation comment for this package)
 

diff --git a/common/reviews/api/graphql-client.api.md b/common/reviews/api/graphql-client.api.md
@@ -4,26 +4,53 @@
 
 ```ts
 
-import type { Meta } from '@/types';
-import type { MetaParser } from '@/types';
-import type { MetaResponse } from '@/types';
-import { queries } from './queries';
-import typeDefs from './gql/schema';
+// @public
+export type Meta = {
+    	variables: {
+        		doctype: string
+        	}
 
-export { Meta }
+    	response: {
+        		getMeta: MetaResponse
+        	}
+}
 
-export { MetaParser }
+// @public
+export type MetaParser = {
+    	data: Meta['response']
+}
 
-export { MetaResponse }
+// @public
+export type MetaResponse = {
+    	id: string
+    	name: string
+    	workflow: {
+        		id: string
+        		name: string
+        		machineId?: string
+        	}
+    	schema: {
+        		id: string
+        		label: string
+        	}[]
+    	actions: {
+        		id: string
+        		eventName: string
+        	}[]
+}
 
 // @public
 export const methods: {
     getMeta: (doctype: string, url?: string) => Promise<MetaResponse>;
 };
 
-export { queries }
+// @public
+export const queries: {
+    getMeta: string;
+};
 
-export { typeDefs }
+// @public
+export const typeDefs: string;
 
 // (No @packageDocumentation comment for this package)
 

diff --git a/desktop/package.json b/desktop/package.json
@@ -43,7 +43,7 @@
 		"xstate": "^4.38.3"
 	},
 	"devDependencies": {
-		"@microsoft/api-documenter": "^7.25.3",
+		"@microsoft/api-documenter": "^7.26.2",
 		"@miragejs/graphql": "^0.1.13",
 		"@rushstack/heft": "^0.68.6",
 		"@typescript-eslint/eslint-plugin": "^7.14.1",

diff --git a/desktop/src/plugins/index.ts b/desktop/src/plugins/index.ts
@@ -6,6 +6,11 @@ import Doctype from '@/components/Doctype.vue'
 import Records from '@/components/Records.vue'
 import SheetNav from '@/components/SheetNav.vue'
 
+/**
+ * This is the main plugin file that will be used to register all the components
+ * that we want to use in our application.
+ * @public
+ */
 const plugin: Plugin = {
 	install: (app: App) => {
 		app.component('ActionSet', ActionSet)

diff --git a/docs/desktop/desktop.md b/docs/desktop/desktop.md
@@ -4,3 +4,28 @@
 
 ## desktop package
 
+## Variables
+
+<table><thead><tr><th>
+
+Variable
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[StonecropDesktop](./desktop.stonecropdesktop.md)
+
+
+</td><td>
+
+This is the main plugin file that will be used to register all the components that we want to use in our application.
+
+
+</td></tr>
+</tbody></table>
diff --git a/docs/desktop/desktop.stonecropdesktop.md b/docs/desktop/desktop.stonecropdesktop.md
@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@stonecrop/desktop](./desktop.md) &gt; [StonecropDesktop](./desktop.stonecropdesktop.md)
+
+## StonecropDesktop variable
+
+This is the main plugin file that will be used to register all the components that we want to use in our application.
+
+**Signature:**
+
+```typescript
+plugin: Plugin = {
+	install: (app: App) => {
+		app.component('ActionSet', ActionSet)
+		app.component('CommandPalette', CommandPalette)
+		app.component('Doctype', Doctype)
+		app.component('Records', Records)
+		app.component('SheetNav', SheetNav)
+	},
+}
+```
diff --git a/docs/graphql_client/graphql-client.md b/docs/graphql_client/graphql-client.md
@@ -27,5 +27,75 @@ Description
 Get meta information for a doctype
 
 
+</td></tr>
+<tr><td>
+
+[queries](./graphql-client.queries.md)
+
+
+</td><td>
+
+Queries for the GraphQL API.
+
+
+</td></tr>
+<tr><td>
+
+[typeDefs](./graphql-client.typedefs.md)
+
+
+</td><td>
+
+This is the schema for the GraphQL API.
+
+
+</td></tr>
+</tbody></table>
+
+## Type Aliases
+
+<table><thead><tr><th>
+
+Type Alias
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[Meta](./graphql-client.meta.md)
+
+
+</td><td>
+
+The type of the response from the `getMeta` query.
+
+
+</td></tr>
+<tr><td>
+
+[MetaParser](./graphql-client.metaparser.md)
+
+
+</td><td>
+
+The type of the response from the `getMeta` query.
+
+
+</td></tr>
+<tr><td>
+
+[MetaResponse](./graphql-client.metaresponse.md)
+
+
+</td><td>
+
+The type of the response from the `getRecords` query.
+
+
 </td></tr>
 </tbody></table>
diff --git a/docs/graphql_client/graphql-client.meta.md b/docs/graphql_client/graphql-client.meta.md
@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@stonecrop/graphql-client](./graphql-client.md) &gt; [Meta](./graphql-client.meta.md)
+
+## Meta type
+
+The type of the response from the `getMeta` query.
+
+**Signature:**
+
+```typescript
+export type Meta = {
+	variables: {
+		doctype: string
+	}
+
+	response: {
+		getMeta: MetaResponse
+	}
+}
+```
+**References:** [MetaResponse](./graphql-client.metaresponse.md)
+