diff --git a/aform/package.json b/aform/package.json index 2caac65a..e7aef462 100644 --- 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 index 064e998b..c1eb4825 100644 --- 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 index deae775b..5483c619 100644 --- 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 index 6c1fbf0d..00fedb4c 100644 --- 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 index b7362329..572f94dc 100644 --- a/common/config/rush/pnpm-lock.yaml +++ b/common/config/rush/pnpm-lock.yaml @@ -26,7 +26,7 @@ importers: version: 3.5.13(typescript@5.7.2) devDependencies: '@microsoft/api-documenter': - specifier: ^7.25.3 + specifier: ^7.26.2 version: 7.26.2(@types/node@22.10.2) '@rushstack/heft': specifier: ^0.68.6 @@ -108,7 +108,7 @@ importers: version: 3.5.13(typescript@5.7.2) devDependencies: '@microsoft/api-documenter': - specifier: ^7.25.3 + specifier: ^7.26.2 version: 7.26.2(@types/node@22.10.2) '@rushstack/heft': specifier: ^0.68.6 @@ -181,7 +181,7 @@ importers: version: 3.5.13(typescript@5.7.2) devDependencies: '@microsoft/api-documenter': - specifier: ^7.25.3 + specifier: ^7.26.2 version: 7.26.2(@types/node@22.10.2) '@rushstack/heft': specifier: ^0.68.6 @@ -257,7 +257,7 @@ importers: version: 3.5.13(typescript@5.7.2) devDependencies: '@microsoft/api-documenter': - specifier: ^7.25.3 + specifier: ^7.26.2 version: 7.26.2(@types/node@22.10.2) '@rushstack/heft': specifier: ^0.68.6 @@ -321,7 +321,7 @@ importers: version: 4.38.3 devDependencies: '@microsoft/api-documenter': - specifier: ^7.25.3 + specifier: ^7.26.2 version: 7.26.2(@types/node@22.10.2) '@miragejs/graphql': specifier: ^0.1.13 @@ -476,7 +476,7 @@ importers: version: 6.0.0(graphql@16.6.0) devDependencies: '@microsoft/api-documenter': - specifier: ^7.25.3 + specifier: ^7.26.2 version: 7.26.2(@types/node@22.10.2) '@miragejs/graphql': specifier: ^0.1.13 @@ -540,7 +540,7 @@ importers: version: 4.38.3 devDependencies: '@microsoft/api-documenter': - specifier: ^7.25.3 + specifier: ^7.26.2 version: 7.26.2(@types/node@22.10.2) '@rushstack/heft': specifier: ^0.68.6 @@ -619,11 +619,14 @@ importers: version: 4.38.3 devDependencies: '@microsoft/api-documenter': - specifier: ^7.25.3 + specifier: ^7.26.2 version: 7.26.2(@types/node@22.10.2) '@rushstack/heft': specifier: ^0.68.6 version: 0.68.10(@types/node@22.10.2) + '@rushstack/heft-typescript-plugin': + specifier: ^0.6.3 + version: 0.6.3(@rushstack/heft@0.68.10(@types/node@22.10.2))(@types/node@22.10.2) '@stonecrop/aform': specifier: workspace:* version: link:../aform @@ -674,7 +677,7 @@ importers: version: 3.5.13(typescript@5.7.2) devDependencies: '@microsoft/api-documenter': - specifier: ^7.25.3 + specifier: ^7.26.2 version: 7.26.2(@types/node@22.10.2) '@rushstack/heft': specifier: ^0.68.6 diff --git a/common/reviews/api/desktop.api.md b/common/reviews/api/desktop.api.md index 9726d346..8578b6c4 100644 --- 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 index df0f1067..8d658ce1 100644 --- 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; }; -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 index 42a09e81..eceb6980 100644 --- 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 index e09b725a..72359ffa 100644 --- 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 index 0d2362dd..49609348 100644 --- a/docs/desktop/desktop.md +++ b/docs/desktop/desktop.md @@ -4,3 +4,28 @@ ## desktop package +## Variables + + + +
+ +Variable + + + + +Description + + +
+ +[StonecropDesktop](./desktop.stonecropdesktop.md) + + + + +This is the main plugin file that will be used to register all the components that we want to use in our application. + + +
diff --git a/docs/desktop/desktop.stonecropdesktop.md b/docs/desktop/desktop.stonecropdesktop.md new file mode 100644 index 00000000..b07a16b7 --- /dev/null +++ b/docs/desktop/desktop.stonecropdesktop.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@stonecrop/desktop](./desktop.md) > [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 index f896e16d..ecc64534 100644 --- 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 + + + +[queries](./graphql-client.queries.md) + + + + +Queries for the GraphQL API. + + + + + +[typeDefs](./graphql-client.typedefs.md) + + + + +This is the schema for the GraphQL API. + + + + + +## Type Aliases + + + + +
+ +Type Alias + + + + +Description + + +
+ +[Meta](./graphql-client.meta.md) + + + + +The type of the response from the `getMeta` query. + + +
+ +[MetaParser](./graphql-client.metaparser.md) + + + + +The type of the response from the `getMeta` query. + + +
+ +[MetaResponse](./graphql-client.metaresponse.md) + + + + +The type of the response from the `getRecords` query. + +
diff --git a/docs/graphql_client/graphql-client.meta.md b/docs/graphql_client/graphql-client.meta.md new file mode 100644 index 00000000..4d02cab1 --- /dev/null +++ b/docs/graphql_client/graphql-client.meta.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@stonecrop/graphql-client](./graphql-client.md) > [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) + diff --git a/docs/graphql_client/graphql-client.metaparser.md b/docs/graphql_client/graphql-client.metaparser.md new file mode 100644 index 00000000..94830d07 --- /dev/null +++ b/docs/graphql_client/graphql-client.metaparser.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [@stonecrop/graphql-client](./graphql-client.md) > [MetaParser](./graphql-client.metaparser.md) + +## MetaParser type + +The type of the response from the `getMeta` query. + +**Signature:** + +```typescript +export type MetaParser = { + data: Meta['response'] +} +``` +**References:** [Meta](./graphql-client.meta.md) + diff --git a/docs/graphql_client/graphql-client.metaresponse.md b/docs/graphql_client/graphql-client.metaresponse.md new file mode 100644 index 00000000..3fd40f85 --- /dev/null +++ b/docs/graphql_client/graphql-client.metaresponse.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [@stonecrop/graphql-client](./graphql-client.md) > [MetaResponse](./graphql-client.metaresponse.md) + +## MetaResponse type + +The type of the response from the `getRecords` query. + +**Signature:** + +```typescript +export type MetaResponse = { + id: string + name: string + workflow: { + id: string + name: string + machineId?: string + } + schema: { + id: string + label: string + }[] + actions: { + id: string + eventName: string + }[] +} +``` diff --git a/docs/graphql_client/graphql-client.queries.md b/docs/graphql_client/graphql-client.queries.md new file mode 100644 index 00000000..7aa46a96 --- /dev/null +++ b/docs/graphql_client/graphql-client.queries.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@stonecrop/graphql-client](./graphql-client.md) > [queries](./graphql-client.queries.md) + +## queries variable + +Queries for the GraphQL API. + +**Signature:** + +```typescript +queries: { + getMeta: string; +} +``` diff --git a/docs/graphql_client/graphql-client.typedefs.md b/docs/graphql_client/graphql-client.typedefs.md new file mode 100644 index 00000000..d2c3954e --- /dev/null +++ b/docs/graphql_client/graphql-client.typedefs.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@stonecrop/graphql-client](./graphql-client.md) > [typeDefs](./graphql-client.typedefs.md) + +## typeDefs variable + +This is the schema for the GraphQL API. + +**Signature:** + +```typescript +typeDefs: string +``` diff --git a/graphql_client/package.json b/graphql_client/package.json index ba33eae8..53f11466 100644 --- a/graphql_client/package.json +++ b/graphql_client/package.json @@ -44,7 +44,7 @@ "graphql-request": "~6.0.0" }, "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/graphql_client/src/gql/schema.ts b/graphql_client/src/gql/schema.ts index 29694c00..a8b57743 100644 --- a/graphql_client/src/gql/schema.ts +++ b/graphql_client/src/gql/schema.ts @@ -1,5 +1,9 @@ import { gql } from 'graphql-request' +/** + * This is the schema for the GraphQL API. + * @public + */ const typeDefs = gql` type Doctype { id: ID! diff --git a/graphql_client/src/queries.ts b/graphql_client/src/queries.ts index f9be5f92..4f87e9ba 100644 --- a/graphql_client/src/queries.ts +++ b/graphql_client/src/queries.ts @@ -1,5 +1,9 @@ import { gql } from 'graphql-request' +/** + * Queries for the GraphQL API. + * @public + */ const queries = { getMeta: gql` query getDoctype($doctype: String!) { diff --git a/graphql_client/src/types/index.ts b/graphql_client/src/types/index.ts index 31b6d840..24349b3b 100644 --- a/graphql_client/src/types/index.ts +++ b/graphql_client/src/types/index.ts @@ -1,3 +1,12 @@ +/** + * @file This file contains all the types that are used in the application. + * @public + */ + +/** + * The type of the response from the `getMeta` query. + * @public + */ export type Meta = { variables: { doctype: string @@ -8,6 +17,10 @@ export type Meta = { } } +/** + * The type of the response from the `getRecords` query. + * @public + */ export type MetaResponse = { id: string name: string @@ -26,6 +39,10 @@ export type MetaResponse = { }[] } +/** + * The type of the response from the `getMeta` query. + * @public + */ export type MetaParser = { data: Meta['response'] } diff --git a/node_editor/package.json b/node_editor/package.json index 2495af77..fd5d1e6b 100644 --- a/node_editor/package.json +++ b/node_editor/package.json @@ -46,7 +46,7 @@ "xstate": "^4.38.3" }, "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/stonecrop/config/heft.json b/stonecrop/config/heft.json new file mode 100644 index 00000000..99244526 --- /dev/null +++ b/stonecrop/config/heft.json @@ -0,0 +1,22 @@ +/** + * Defines configuration used by core Heft. + */ +{ + "$schema": "https://developer.microsoft.com/json-schemas/heft/v0/heft.schema.json", + + "phasesByName": { + "build": { + "phaseDescription": "This phase compiles the project source code.", + + "cleanFiles": [{ "sourcePath": "dist" }], + + "tasksByName": { + "typescript": { + "taskPlugin": { + "pluginPackage": "@rushstack/heft-typescript-plugin" + } + } + } + } + } +} diff --git a/stonecrop/package.json b/stonecrop/package.json index bf353202..449eacc9 100644 --- a/stonecrop/package.json +++ b/stonecrop/package.json @@ -48,8 +48,9 @@ "xstate": "^4.38.3" }, "devDependencies": { - "@microsoft/api-documenter": "^7.25.3", + "@microsoft/api-documenter": "^7.26.2", "@rushstack/heft": "^0.68.6", + "@rushstack/heft-typescript-plugin": "^0.6.3", "@stonecrop/aform": "workspace:*", "@stonecrop/atable": "workspace:*", "@typescript-eslint/eslint-plugin": "^7.14.1", diff --git a/utilities/package.json b/utilities/package.json index 1424636f..a3d7b4d6 100644 --- a/utilities/package.json +++ b/utilities/package.json @@ -42,7 +42,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",