Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Chore] Manual typedoc update #1982

Merged
merged 5 commits into from
Nov 26, 2024
Merged

[Chore] Manual typedoc update #1982

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
afae5c8
Revert "Revert "[Chore] Update typedoc for compatibility with latest …
art-alexeyenko Nov 25, 2024
b5a46b6
[Chore] Post-typedoc-update doc update
art-alexeyenko Nov 25, 2024
c7cc0f4
Merge branch 'dev' of https://github.com/Sitecore/jss into chore/manu…
art-alexeyenko Nov 25, 2024
e507e97
Apply v3-like behavior for typedoc-plugin-markdown
art-alexeyenko Nov 25, 2024
663688b
v3-like doc generation
art-alexeyenko Nov 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@
"eslint-plugin-prettier": "^3.3.0",
"lerna": "^5.6.2",
"prettier": "^1.14.3",
"typedoc": "^0.24.0",
"typedoc-plugin-markdown": "^3.11.3",
"typedoc": "^0.26.0",
"typedoc-plugin-markdown": "^4.2.10",
"typescript": "~5.6.3"
},
"resolutions": {
Expand Down
2 changes: 1 addition & 1 deletion packages/sitecore-jss-angular-schematics/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"test-package": "jasmine src/**/*_spec.js",
"test": "npm run build && npm run test-package",
"coverage": "nyc npm run test-package",
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-angular-schematics src/jss-component/index.ts --githubPages false"
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/sitecore-jss-angular-schematics src/jss-component/index.ts --githubPages false"
},
"engines": {
"node": ">=22"
Expand Down
2 changes: 1 addition & 1 deletion packages/sitecore-jss-angular/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"test": "ng test",
"test:watch": "ng test --watch --browsers Chrome",
"coverage": "ng test --code-coverage",
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-angular src/public_api.ts --githubPages false"
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/sitecore-jss-angular src/public_api.ts --githubPages false"
},
"engines": {
"node": ">=22"
Expand Down
2 changes: 1 addition & 1 deletion packages/sitecore-jss-dev-tools/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"test": "mocha --require ts-node/register -r tsconfig-paths/register \"./src/**/*.test.ts\"",
"prepublishOnly": "npm run build",
"coverage": "nyc npm test",
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-dev-tools src/index.ts --githubPages false"
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/sitecore-jss-dev-tools src/index.ts --githubPages false"
},
"engines": {
"node": ">=22"
Expand Down
2 changes: 1 addition & 1 deletion packages/sitecore-jss-forms/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"test": "mocha --require ts-node/register \"./src/**/*.test.ts\"",
"prepublishOnly": "npm run build",
"coverage": "nyc npm test",
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-forms src/index.ts --githubPages false"
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/sitecore-jss-forms src/index.ts --githubPages false"
},
"engines": {
"node": ">=22"
Expand Down
2 changes: 1 addition & 1 deletion packages/sitecore-jss-nextjs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"test": "mocha --require ./test/setup.js \"./src/**/*.test.ts\" \"./src/**/*.test.tsx\" --exit",
"prepublishOnly": "npm run build",
"coverage": "nyc npm test",
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-nextjs --entryPoints src/index.ts --entryPoints src/monitoring/index.ts --entryPoints src/editing/index.ts --entryPoints src/middleware/index.ts --entryPoints src/context/index.ts --entryPoints src/utils/index.ts --entryPoints src/site/index.ts --entryPoints src/graphql/index.ts --githubPages false"
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/sitecore-jss-nextjs --entryPoints src/index.ts --entryPoints src/monitoring/index.ts --entryPoints src/editing/index.ts --entryPoints src/middleware/index.ts --entryPoints src/context/index.ts --entryPoints src/utils/index.ts --entryPoints src/site/index.ts --entryPoints src/graphql/index.ts --githubPages false"
},
"engines": {
"node": ">=22"
Expand Down
2 changes: 1 addition & 1 deletion packages/sitecore-jss-proxy/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"test": "mocha --require ts-node/register \"./src/**/*.test.ts\" --exit",
"prepublishOnly": "npm run build",
"coverage": "nyc npm test",
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --entryPoints src/personalize/index.ts --out ../../ref-docs/sitecore-jss-proxy src/index.ts --githubPages false"
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --entryPoints src/personalize/index.ts --out ../../ref-docs/sitecore-jss-proxy src/index.ts --githubPages false"
},
"engines": {
"node": ">=22"
Expand Down
2 changes: 1 addition & 1 deletion packages/sitecore-jss-react-forms/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"test": "mocha --require ts-node/register/transpile-only --require ./src/tests/shim.ts ./src/tests/jsdom-setup.ts ./src/tests/enzyme-setup.ts \"./src/**/*.test.tsx\" --exit",
"prepublishOnly": "npm run build",
"coverage": "nyc npm test",
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-forms src/index.ts --githubPages false"
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/sitecore-jss-forms src/index.ts --githubPages false"
},
"engines": {
"node": ">=22"
Expand Down
2 changes: 1 addition & 1 deletion packages/sitecore-jss-react-native/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"test": "jest",
"prepublishOnly": "npm test && npm run build",
"coverage": "jest --config ./jest.config.coverage.js",
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-react-native src/index.ts --githubPages false"
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/sitecore-jss-react-native src/index.ts --githubPages false"
},
"engines": {
"node": ">=22"
Expand Down
2 changes: 1 addition & 1 deletion packages/sitecore-jss-react/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"test": "mocha --require ts-node/register/transpile-only --require ./src/tests/shim.ts ./src/tests/jsdom-setup.ts ./src/tests/enzyme-setup.ts \"./src/**/*.test.ts\" \"./src/**/*.test.tsx\" --exit",
"prepublishOnly": "npm run build",
"coverage": "nyc npm test",
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-react src/index.ts --githubPages false"
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/sitecore-jss-react src/index.ts --githubPages false"
},
"engines": {
"node": ">=22"
Expand Down
2 changes: 1 addition & 1 deletion packages/sitecore-jss-rendering-host/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"test": "mocha --require ts-node/register/transpile-only \"./src/**/*.test.ts\"",
"prepublishOnly": "npm run build",
"coverage": "nyc npm test",
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-rendering-host src/index.ts --githubPages false"
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/sitecore-jss-rendering-host src/index.ts --githubPages false"
},
"engines": {
"node": ">=22"
Expand Down
2 changes: 1 addition & 1 deletion packages/sitecore-jss-vue/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"test": "jest",
"prepublishOnly": "npm run build",
"coverage": "jest --config ./jest.config.coverage.js",
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-vue src/index.ts --githubPages false"
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/sitecore-jss-vue src/index.ts --githubPages false"
},
"engines": {
"node": ">=22"
Expand Down
2 changes: 1 addition & 1 deletion packages/sitecore-jss/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"test": "mocha --require ts-node/register \"./src/**/*.test.ts\"",
"prepublishOnly": "npm run build",
"coverage": "nyc npm test",
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss --entryPoints src/index.ts --entryPoints src/graphql/index.ts --entryPoints src/i18n/index.ts --entryPoints src/layout/index.ts --entryPoints src/media/index.ts --entryPoints src/personalize/index.ts --entryPoints src/site/index.ts --entryPoints src/tracking/index.ts --entryPoints src/utils/index.ts --entryPoints src/editing/index.ts --githubPages false"
"generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/sitecore-jss --entryPoints src/index.ts --entryPoints src/graphql/index.ts --entryPoints src/i18n/index.ts --entryPoints src/layout/index.ts --entryPoints src/media/index.ts --entryPoints src/personalize/index.ts --entryPoints src/site/index.ts --entryPoints src/tracking/index.ts --entryPoints src/utils/index.ts --entryPoints src/editing/index.ts --githubPages false"
},
"engines": {
"node": ">=22"
Expand Down
40 changes: 4 additions & 36 deletions ref-docs/sitecore-jss-angular-schematics/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,41 +1,9 @@
@sitecore-jss/sitecore-jss-angular-schematics
**@sitecore-jss/sitecore-jss-angular-schematics** • **Docs**

# @sitecore-jss/sitecore-jss-angular-schematics

## Table of contents
***

### Functions

- [default](README.md#default)
# @sitecore-jss/sitecore-jss-angular-schematics

## Functions

### default

▸ **default**(`options`): (`host`: `Tree`) => `Promise`\<`Rule`\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `options` | `Schema` |

#### Returns

`fn`

▸ (`host`): `Promise`\<`Rule`\>

##### Parameters

| Name | Type |
| :------ | :------ |
| `host` | `Tree` |

##### Returns

`Promise`\<`Rule`\>

#### Defined in

[index.ts:41](https://github.com/Sitecore/jss/blob/c7112389e/packages/sitecore-jss-angular-schematics/src/jss-component/index.ts#L41)
- [default](functions/default.md)
10 changes: 7 additions & 3 deletions ref-docs/sitecore-jss-angular-schematics/functions/default.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,24 @@

## Parameters

• **options**: `Schema`
| Parameter | Type |
| ------ | ------ |
| `options` | `Schema` |

## Returns

`Function`

### Parameters

• **host**: `Tree`
| Parameter | Type |
| ------ | ------ |
| `host` | `Tree` |

### Returns

`Promise`\<`Rule`\>

## Defined in

[index.ts:41](https://github.com/Sitecore/jss/blob/ff400466a8d16483c667d9a837e1247d6192035e/packages/sitecore-jss-angular-schematics/src/jss-component/index.ts#L41)
[index.ts:41](https://github.com/Sitecore/jss/blob/e507e97cfa27e316b3c99ba5c513dce49973a5f1/packages/sitecore-jss-angular-schematics/src/jss-component/index.ts#L41)
4 changes: 2 additions & 2 deletions ref-docs/sitecore-jss-angular/classes/BaseJssState.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

#### Defined in

[packages/sitecore-jss-angular/src/services/jss-state.service.ts:6](https://github.com/Sitecore/jss/blob/ff400466a8d16483c667d9a837e1247d6192035e/packages/sitecore-jss-angular/src/services/jss-state.service.ts#L6)
[packages/sitecore-jss-angular/src/services/jss-state.service.ts:6](https://github.com/Sitecore/jss/blob/e507e97cfa27e316b3c99ba5c513dce49973a5f1/packages/sitecore-jss-angular/src/services/jss-state.service.ts#L6)

***

Expand All @@ -44,4 +44,4 @@

#### Defined in

[packages/sitecore-jss-angular/src/services/jss-state.service.ts:9](https://github.com/Sitecore/jss/blob/ff400466a8d16483c667d9a837e1247d6192035e/packages/sitecore-jss-angular/src/services/jss-state.service.ts#L9)
[packages/sitecore-jss-angular/src/services/jss-state.service.ts:9](https://github.com/Sitecore/jss/blob/e507e97cfa27e316b3c99ba5c513dce49973a5f1/packages/sitecore-jss-angular/src/services/jss-state.service.ts#L9)
64 changes: 20 additions & 44 deletions ref-docs/sitecore-jss-angular/classes/CdpHelper.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,12 @@ Gets the friendly id for Component A/B Testing in the required format `component

#### Parameters

• **pageId**: `string`

the page id

• **componentId**: `string`

the component id

• **language**: `string`

the language

• **scope?**: `string`

the scope value
| Parameter | Type | Description |
| ------ | ------ | ------ |
| `pageId` | `string` | the page id |
| `componentId` | `string` | the component id |
| `language` | `string` | the language |
| `scope`? | `string` | the scope value |

#### Returns

Expand All @@ -64,17 +55,11 @@ Gets the friendly id for (page-level) Embedded Personalization in the required f

#### Parameters

• **pageId**: `string`

the page id

• **language**: `string`

the language

• **scope?**: `string`

the scope value
| Parameter | Type | Description |
| ------ | ------ | ------ |
| `pageId` | `string` | the page id |
| `language` | `string` | the language |
| `scope`? | `string` | the scope value |

#### Returns

Expand All @@ -96,21 +81,12 @@ Gets the page variant id for CDP in the required format

#### Parameters

• **pageId**: `string`

the page id

• **language**: `string`

the language

• **variantId**: `string`

the variant id

• **scope?**: `string`

the scope value
| Parameter | Type | Description |
| ------ | ------ | ------ |
| `pageId` | `string` | the page id |
| `language` | `string` | the language |
| `variantId` | `string` | the variant id |
| `scope`? | `string` | the scope value |

#### Returns

Expand All @@ -133,9 +109,9 @@ Removes all non-alphanumeric characters

#### Parameters

• **scope?**: `string`

the scope value
| Parameter | Type | Description |
| ------ | ------ | ------ |
| `scope`? | `string` | the scope value |

#### Returns

Expand Down
21 changes: 12 additions & 9 deletions ref-docs/sitecore-jss-angular/classes/ClientError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@

#### Parameters

• **response**: `GraphQLResponse`\<`any`\>

• **request**: `GraphQLRequestContext`\<`Variables`\>
| Parameter | Type |
| ------ | ------ |
| `response` | `GraphQLResponse`\<`any`\> |
| `request` | `GraphQLRequestContext`\<`Variables`\> |

#### Returns

Expand Down Expand Up @@ -138,9 +139,10 @@ Optional override for formatting stack traces

#### Parameters

• **err**: `Error`

• **stackTraces**: `CallSite`[]
| Parameter | Type |
| ------ | ------ |
| `err` | `Error` |
| `stackTraces` | `CallSite`[] |

#### Returns

Expand Down Expand Up @@ -182,9 +184,10 @@ Create .stack property on a target object

#### Parameters

• **targetObject**: `object`

• **constructorOpt?**: `Function`
| Parameter | Type |
| ------ | ------ |
| `targetObject` | `object` |
| `constructorOpt`? | `Function` |

#### Returns

Expand Down
8 changes: 4 additions & 4 deletions ref-docs/sitecore-jss-angular/classes/ComponentNameAndType.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Registers a statically loaded component

#### Defined in

[packages/sitecore-jss-angular/src/services/placeholder.token.ts:12](https://github.com/Sitecore/jss/blob/ff400466a8d16483c667d9a837e1247d6192035e/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L12)
[packages/sitecore-jss-angular/src/services/placeholder.token.ts:12](https://github.com/Sitecore/jss/blob/e507e97cfa27e316b3c99ba5c513dce49973a5f1/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L12)

***

Expand All @@ -36,7 +36,7 @@ Registers a statically loaded component

#### Defined in

[packages/sitecore-jss-angular/src/services/placeholder.token.ts:9](https://github.com/Sitecore/jss/blob/ff400466a8d16483c667d9a837e1247d6192035e/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L9)
[packages/sitecore-jss-angular/src/services/placeholder.token.ts:9](https://github.com/Sitecore/jss/blob/e507e97cfa27e316b3c99ba5c513dce49973a5f1/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L9)

***

Expand All @@ -50,7 +50,7 @@ Registers a statically loaded component

#### Defined in

[packages/sitecore-jss-angular/src/services/placeholder.token.ts:17](https://github.com/Sitecore/jss/blob/ff400466a8d16483c667d9a837e1247d6192035e/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L17)
[packages/sitecore-jss-angular/src/services/placeholder.token.ts:17](https://github.com/Sitecore/jss/blob/e507e97cfa27e316b3c99ba5c513dce49973a5f1/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L17)

***

Expand All @@ -60,4 +60,4 @@ Registers a statically loaded component

#### Defined in

[packages/sitecore-jss-angular/src/services/placeholder.token.ts:10](https://github.com/Sitecore/jss/blob/ff400466a8d16483c667d9a837e1247d6192035e/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L10)
[packages/sitecore-jss-angular/src/services/placeholder.token.ts:10](https://github.com/Sitecore/jss/blob/e507e97cfa27e316b3c99ba5c513dce49973a5f1/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L10)
Loading