Skip to content

feat: update document generator library #1111

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.

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

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ jobs:
command: |
yarn build
yarn test:ci
yarn apidoc:ci
yarn typedoc
# Upload results
- store_test_results:
path: ./reports
Expand Down
4 changes: 2 additions & 2 deletions .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
{"varsIgnorePattern": "^_", "argsIgnorePattern": "^_"}
],
"@typescript-eslint/no-empty-function": "off",
"@typescript-eslint/no-empty-interface": "off",
"tsdoc/syntax": "error"
"tsdoc/syntax": "warn",
"@typescript-eslint/no-empty-interface": "off"
}
}
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## 1.36.0 [unreleased]

### Features:

1.[1111](https://github.com/influxdata/influxdb-client-js/pull/1111) Change the document library to Typedocc

## 1.35.0 [2024-08-15]

### Bug Fixes
Expand Down
11 changes: 4 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,8 @@
]
},
"scripts": {
"apidoc": "yarn clean && yarn build && yarn apidoc:extract && yarn apidoc:generate",
"apidoc:ci": "yarn apidoc:extract && yarn apidoc:generate",
"apidoc:extract": "yarn workspaces run apidoc:extract && node scripts/fix-extracted-api-files.js",
"apidoc:generate": "api-documenter markdown -i docs -o docs/dist && cp scripts/gh-pages_config.yml docs/dist/_config.yml && node scripts/enhance-doc-index-md.js",
"apidoc:gh-pages": "gh-pages -d docs/dist -m 'Updates [skip CI]'",
"typedoc": "typedoc --skipErrorChecking",
"typedoc:gh-pages": "yarn typedoc && gh-pages -d ./docs -m 'docs: updates documentation [skip CI]' --dotfiles",
"preinstall": "node ./scripts/require-yarn.js",
"clean": "rimraf temp docs && yarn workspaces run clean",
"build": "yarn workspaces run build",
Expand All @@ -39,11 +36,11 @@
},
"license": "MIT",
"devDependencies": {
"@microsoft/api-documenter": "^7.19.12",
"@types/node": "^22",
"gh-pages": "^6.0.0",
"lerna": "^8.0.2",
"prettier": "^3.0.3",
"rimraf": "^5.0.1"
"rimraf": "^5.0.1",
"typedoc": "^0.27.5"
}
}
8 changes: 0 additions & 8 deletions packages/apis/api-extractor.json

This file was deleted.

6 changes: 2 additions & 4 deletions packages/apis/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,14 @@
"version": "1.35.0",
"description": "InfluxDB 2.x generated APIs",
"scripts": {
"apidoc:extract": "api-extractor run",
"build": "yarn run clean && yarn tsup --config ./tsup.config.browser.ts && yarn tsup && node ../../scripts/repair-doc-code-blocks.js ./dist/index.d.ts",
"build": "yarn run clean && yarn tsup --config ./tsup.config.browser.ts && yarn tsup",
"clean": "rimraf build doc dist reports",
"clean:apis": "rimraf src/generated/*API.ts",
"test": "yarn run lint && yarn run typecheck && yarn run test:unit",
"test:unit": "mocha --require esbuild-runner/register 'test/unit/**/*.test.ts' --exit",
"test:ci": "yarn run typecheck && yarn run lint:ci && yarn run test:unit --reporter mocha-junit-reporter --reporter-options mochaFile=../../reports/apis_mocha/test-results.xml",
"typecheck": "tsc --noEmit --pretty",
"lint": "eslint --max-warnings 0 'src/**/*.ts'",
"lint": "eslint 'src/**/*.ts'",
"lint:ci": "yarn run lint --format junit --output-file ../../reports/apis_eslint/eslint.xml",
"lint:fix": "eslint --fix 'src/**/*.ts'",
"regenerate": "yarn fetchSwaggerFiles && yarn generate && yarn test",
Expand Down Expand Up @@ -59,7 +58,6 @@
"devDependencies": {
"@influxdata/influxdb-client": "^1.35.0",
"@influxdata/oats": "^0.7.0",
"@microsoft/api-extractor": "^7.31.0",
"@types/mocha": "^10.0.0",
"@typescript-eslint/eslint-plugin": "^7.1.0",
"@typescript-eslint/parser": "^8.0.0",
Expand Down
7 changes: 1 addition & 6 deletions packages/apis/src/APIBase.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
// this is effectively a clone of
import {
InfluxDB,
Transport,
SendOptions,
Headers,
} from '@influxdata/influxdb-client'
import {InfluxDB, Transport, SendOptions, Headers} from '../../core/src'

// used only in browser builds
declare function btoa(plain: string): string
Expand Down
6 changes: 1 addition & 5 deletions packages/apis/src/custom/FluxScriptInvocationAPI.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
import {
InfluxDB,
Transport,
AnnotatedCSVResponse,
} from '@influxdata/influxdb-client'
import {InfluxDB, Transport, AnnotatedCSVResponse} from '../../../core/src'

/** ExecutionOptions contains execution options for a flux script. */
export interface ExecutionOptions {
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/AuthorizationsAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {
Authorization,
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/BackupAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {MetadataBackup} from './types'

Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/BucketsAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {
AddResourceMemberRequestBody,
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/ChecksAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {
Check,
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/ConfigAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {Config} from './types'

Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/DashboardsAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {
AddResourceMemberRequestBody,
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/DbrpsAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {DBRP, DBRPCreate, DBRPGet, DBRPUpdate, DBRPs} from './types'

Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/DebugAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'

export interface GetDebugPprofAllProfilesRequest {
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/DeleteAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {DeletePredicateRequest} from './types'

Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/FlagsAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {Flags} from './types'

Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/HealthAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {HealthCheck} from './types'

Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/LabelsAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {
LabelCreateRequest,
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/MeAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {PasswordResetBody, UserResponse} from './types'

Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/MetricsAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'

export interface GetMetricsRequest {}
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/NotificationEndpointsAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {
LabelMapping,
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/NotificationRulesAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {
FluxResponse,
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/OrgsAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {
AddResourceMemberRequestBody,
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/PingAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'

export interface GetPingRequest {}
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/QueryAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {
ASTResponse,
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/ReadyAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {Ready} from './types'

Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/RemotesAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {
RemoteConnection,
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/ReplicationsAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {
Replication,
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/ResourcesAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'

export interface GetResourcesRequest {}
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/RestoreAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {BucketMetadataManifest, RestoredBucketMappings} from './types'

Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/RootAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {Routes} from './types'

Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/ScrapersAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {
AddResourceMemberRequestBody,
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/ScriptsAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {
Script,
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/SetupAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {IsOnboarding, OnboardingRequest, OnboardingResponse} from './types'

Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/SigninAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'

export interface PostSigninRequest {
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/SignoutAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'

export interface PostSignoutRequest {}
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/SourcesAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {Buckets, HealthCheck, Source, Sources} from './types'

Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/StacksAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {Stack} from './types'

Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/TasksAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {
AddResourceMemberRequestBody,
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/TelegrafAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {TelegrafPlugins} from './types'

Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/TelegrafsAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {
AddResourceMemberRequestBody,
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/TemplatesAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {
Template,
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/UsersAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {PasswordResetBody, User, UserResponse, Users} from './types'

Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/VariablesAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'
import {
LabelMapping,
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/generated/WriteAPI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {InfluxDB} from '@influxdata/influxdb-client'
import {InfluxDB} from '../../../core/src'
import {APIBase, RequestOptions} from '../APIBase'

export interface PostWriteRequest {
Expand Down
2 changes: 1 addition & 1 deletion packages/apis/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* ```

* Generated APIs that write or query InfluxDB are also herein, but it is recommended to use
* {@link @influxdata/influxdb-client#WriteApi} and {@link @influxdata/influxdb-client#QueryApi}
* {@link @influxdata/influxdb-client!WriteApi} and {@link @influxdata/influxdb-client!QueryApi}
* from `@influxdata/influxdb-client`, they are much easier to use and offer specialized features
* (write failover, line protocol serialization, flux results parsing, ...).
*
Expand Down
8 changes: 0 additions & 8 deletions packages/core/api-extractor.json

This file was deleted.

2 changes: 0 additions & 2 deletions packages/core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
"version": "1.35.0",
"description": "InfluxDB 2.x client",
"scripts": {
"apidoc:extract": "api-extractor run",
"build": "yarn run clean && yarn tsup --config ./tsup.config.browser.ts && yarn tsup",
"clean": "rimraf dist build coverage .nyc_output doc *.lcov reports",
"coverage": "nyc mocha --require ts-node/register 'test/**/*.test.ts' --exit",
Expand Down Expand Up @@ -54,7 +53,6 @@
},
"license": "MIT",
"devDependencies": {
"@microsoft/api-extractor": "^7.31.0",
"@types/chai": "^4.2.5",
"@types/mocha": "^10.0.0",
"@types/sinon": "^17.0.2",
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/Point.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ export class Point {
/**
* Adds a boolean field.
*
* @param field - field name
* @param name - field name
* @param value - field value
* @returns this
*/
Expand Down
Loading