From 961272732d7d6f508e425921d85dbc573fcd472b Mon Sep 17 00:00:00 2001 From: "jesus.lopez-fernandez" Date: Wed, 20 Nov 2024 17:01:45 +0100 Subject: [PATCH] First release --- .eslintignore | 1 + .eslintrc.js | 24 + .github/workflows/ci-cd-implementation.yml | 47 + .gitignore | 3 + CODEOWNERS | 1 + CODE_OF_CONDUCT.md | 128 + License.md | 20 + README.md | 222 + docs/.nojekyll | 1 + docs/classes/alarms.Acknowledgement.md | 46 + docs/classes/alarms.Alarms.md | 79 + docs/classes/alarms.AlarmsAcknowledge.md | 383 + .../alarms.AlarmsAcknowledgeResponse.md | 174 + docs/classes/alarms.AlarmsBrowse.md | 386 + docs/classes/alarms.AlarmsBrowseResponse.md | 174 + docs/classes/alarms.EntryAlarm.md | 134 + docs/classes/alarms.Filters.md | 46 + docs/classes/api.ApiBrowse.md | 381 + docs/classes/api.ApiBrowseResponse.md | 174 + docs/classes/api.ApiBrowseTickets.md | 383 + docs/classes/api.ApiBrowseTicketsResponse.md | 174 + docs/classes/api.ApiChangePassword.md | 385 + docs/classes/api.ApiChangePasswordResponse.md | 174 + docs/classes/api.ApiCloseTickets.md | 383 + docs/classes/api.ApiCloseTicketsResponse.md | 174 + docs/classes/api.ApiGetAuthenticationMode.md | 381 + .../api.ApiGetAuthenticationModeResponse.md | 174 + docs/classes/api.ApiGetCertificateUrl.md | 381 + .../api.ApiGetCertificateUrlResponse.md | 174 + docs/classes/api.ApiGetPasswordPolicy.md | 381 + .../api.ApiGetPasswordPolicyResponse.md | 174 + docs/classes/api.ApiGetPermissions.md | 381 + docs/classes/api.ApiGetPermissionsResponse.md | 174 + docs/classes/api.ApiGetQuantityStructures.md | 382 + .../api.ApiGetQuantityStructuresResponse.md | 174 + docs/classes/api.ApiLogin.md | 384 + docs/classes/api.ApiLoginResponse.md | 174 + docs/classes/api.ApiLogout.md | 382 + docs/classes/api.ApiLogoutResponse.md | 174 + docs/classes/api.ApiPing.md | 381 + docs/classes/api.ApiPingResponse.md | 174 + docs/classes/api.ApiTicket.md | 79 + docs/classes/api.ApiVersion.md | 381 + docs/classes/api.ApiVersionResponse.md | 174 + docs/classes/api.CustomTicket.md | 46 + docs/classes/api.PasswordPolicy.md | 90 + docs/classes/api.QuantityStructure.md | 57 + .../datalogs.DataLogsDownloadAndClear.md | 383 + ...talogs.DataLogsDownloadAndClearResponse.md | 174 + ...diagnosticbuffer.DiagnosticBufferBrowse.md | 385 + ...icbuffer.DiagnosticBufferBrowseResponse.md | 174 + ...gnosticbuffer.DiagnosticBufferStructure.md | 79 + docs/classes/diagnosticbuffer.Entry.md | 90 + docs/classes/diagnosticbuffer.Event.md | 46 + docs/classes/diagnosticbuffer.Filters.md | 46 + docs/classes/failsafe.CPUResponse.md | 57 + .../failsafe.FailsafeReadParameters.md | 383 + ...failsafe.FailsafeReadParametersResponse.md | 174 + ...ailsafe.FailsafeReadParametersStructure.md | 57 + .../failsafe.FailsafeReadRuntimeGroups.md | 382 + ...lsafe.FailsafeReadRuntimeGroupsResponse.md | 174 + ...safe.FailsafeReadRuntimeGroupsStructure.md | 90 + docs/classes/failsafe.ModuleResponse.md | 68 + docs/classes/files.FilesBrowse.md | 383 + docs/classes/files.FilesBrowseResponse.md | 174 + docs/classes/files.FilesCreate.md | 383 + docs/classes/files.FilesCreateDirectory.md | 383 + .../files.FilesCreateDirectoryResponse.md | 174 + docs/classes/files.FilesCreateResponse.md | 174 + docs/classes/files.FilesDelete.md | 383 + docs/classes/files.FilesDeleteDirectory.md | 383 + .../files.FilesDeleteDirectoryResponse.md | 174 + docs/classes/files.FilesDeleteResponse.md | 174 + docs/classes/files.FilesDownload.md | 383 + docs/classes/files.FilesDownloadResponse.md | 174 + docs/classes/files.FilesRename.md | 384 + docs/classes/files.FilesRenameResponse.md | 174 + docs/classes/files.Resources.md | 79 + docs/classes/plc.PlcCreateBackup.md | 382 + docs/classes/plc.PlcCreateBackupResponse.md | 174 + docs/classes/plc.PlcReadOperatingMode.md | 382 + .../plc.PlcReadOperatingModeResponse.md | 174 + docs/classes/plc.PlcReadSystemTime.md | 381 + docs/classes/plc.PlcReadSystemTimeResponse.md | 174 + docs/classes/plc.PlcReadTimeSettings.md | 381 + .../plc.PlcReadTimeSettingsResponse.md | 174 + .../plc.PlcRequestChangeOperatingMode.md | 383 + ...c.PlcRequestChangeOperatingModeResponse.md | 174 + docs/classes/plc.PlcRestoreBackup.md | 383 + docs/classes/plc.PlcRestoreBackupResponse.md | 174 + docs/classes/plc.PlcSetSystemTime.md | 383 + docs/classes/plc.PlcSetSystemTimeResponse.md | 174 + docs/classes/plc.PlcSetTimeSettings.md | 383 + .../classes/plc.PlcSetTimeSettingsResponse.md | 174 + docs/classes/plc.Rule.md | 46 + docs/classes/plc.RuleDst.md | 46 + docs/classes/plc.RuleStart.md | 79 + docs/classes/plc.RuleStd.md | 35 + docs/classes/plc.TimeSettings.md | 57 + docs/classes/plcprogram.PlcProgramBrowse.md | 385 + .../plcprogram.PlcProgramBrowseArrayData.md | 46 + .../plcprogram.PlcProgramBrowseResponse.md | 174 + .../plcprogram.PlcProgramBrowseVariable.md | 145 + ...program.PlcProgramDownloadProfilingData.md | 382 + ...PlcProgramDownloadProfilingDataResponse.md | 174 + docs/classes/plcprogram.PlcProgramRead.md | 384 + .../plcprogram.PlcProgramReadResponse.md | 174 + docs/classes/plcprogram.PlcProgramWrite.md | 385 + .../plcprogram.PlcProgramWriteResponse.md | 174 + docs/classes/project.Languages.md | 35 + docs/classes/project.ProjectLanguages.md | 382 + .../project.ProjectLanguagesResponse.md | 174 + docs/classes/request.JsonrpcBaseRequest.md | 446 + docs/classes/request.RequestConfig.md | 90 + docs/classes/response.JsonrpcBaseResponse.md | 267 + docs/classes/response.JsonrpcError.md | 101 + docs/classes/syslog.SyslogBrowse.md | 385 + docs/classes/syslog.SyslogBrowseResponse.md | 174 + docs/classes/syslog.SyslogBrowseStructure.md | 57 + docs/classes/syslog.SyslogData.md | 35 + .../classes/ticket.ProxyTicketDownloadData.md | 395 + docs/classes/ticket.ProxyTicketUploadData.md | 178 + docs/classes/ticket.TicketDownloadData.md | 387 + docs/classes/ticket.TicketUploadData.md | 395 + docs/classes/webApp.Application.md | 57 + .../webApp.BrowseResourcesStructure.md | 46 + docs/classes/webApp.BrowseStructure.md | 46 + docs/classes/webApp.Resource.md | 90 + docs/classes/webApp.WebAppBrowse.md | 382 + docs/classes/webApp.WebAppBrowseResources.md | 384 + .../webApp.WebAppBrowseResourcesResponse.md | 174 + docs/classes/webApp.WebAppBrowseResponse.md | 174 + docs/classes/webApp.WebAppCreate.md | 384 + docs/classes/webApp.WebAppCreateResource.md | 388 + .../webApp.WebAppCreateResourceResponse.md | 174 + docs/classes/webApp.WebAppCreateResponse.md | 174 + docs/classes/webApp.WebAppDelete.md | 383 + docs/classes/webApp.WebAppDeleteResource.md | 384 + .../webApp.WebAppDeleteResourceResponse.md | 174 + docs/classes/webApp.WebAppDeleteResponse.md | 174 + docs/classes/webApp.WebAppDownloadResource.md | 384 + .../webApp.WebAppDownloadResourceResponse.md | 174 + docs/classes/webApp.WebAppRename.md | 384 + docs/classes/webApp.WebAppRenameResource.md | 385 + .../webApp.WebAppRenameResourceResponse.md | 174 + docs/classes/webApp.WebAppRenameResponse.md | 174 + docs/classes/webApp.WebAppSetDefaultPage.md | 384 + .../webApp.WebAppSetDefaultPageResponse.md | 174 + .../webApp.WebAppSetNotAuthorizedPage.md | 384 + ...bApp.WebAppSetNotAuthorizedPageResponse.md | 174 + docs/classes/webApp.WebAppSetNotFoundPage.md | 384 + .../webApp.WebAppSetNotFoundPageResponse.md | 174 + docs/classes/webApp.WebAppSetResourceETag.md | 385 + .../webApp.WebAppSetResourceETagResponse.md | 174 + .../webApp.WebAppSetResourceMediaType.md | 385 + ...bApp.WebAppSetResourceMediaTypeResponse.md | 174 + ...ebApp.WebAppSetResourceModificationTime.md | 385 + ...bAppSetResourceModificationTimeResponse.md | 174 + .../webApp.WebAppSetResourceVisibility.md | 385 + ...App.WebAppSetResourceVisibilityResponse.md | 174 + docs/classes/webApp.WebAppSetState.md | 384 + docs/classes/webApp.WebAppSetStateResponse.md | 174 + .../webserver.WebServerReadDefaultPage.md | 381 + ...server.WebServerReadDefaultPageResponse.md | 174 + .../webserver.WebServerSetDefaultPage.md | 383 + ...bserver.WebServerSetDefaultPageResponse.md | 174 + docs/enums/api.ApiTicketState.md | 54 + docs/enums/plc.PlcOpertingMode.md | 65 + docs/modules.md | 24 + docs/modules/alarms.md | 16 + docs/modules/api.md | 42 + docs/modules/datalogs.md | 10 + docs/modules/diagnosticbuffer.md | 14 + docs/modules/failsafe.md | 16 + docs/modules/files.md | 23 + docs/modules/index.md | 1121 +++ docs/modules/plc.md | 64 + docs/modules/plcprogram.md | 18 + docs/modules/project.md | 11 + docs/modules/request.md | 10 + docs/modules/response.md | 10 + docs/modules/syslog.md | 12 + docs/modules/ticket.md | 12 + docs/modules/webApp.md | 46 + docs/modules/webserver.md | 12 + jest.config.js | 5 + package-lock.json | 7601 +++++++++++++++++ package.json | 49 + src/alarms.ts | 169 + src/api.ts | 547 ++ src/datalogs.ts | 34 + src/diagnosticbuffer.ts | 122 + src/failsafe.ts | 163 + src/files.ts | 258 + src/index.ts | 15 + src/plc.ts | 391 + src/plcprogram.ts | 190 + src/project.ts | 57 + src/request.ts | 283 + src/response.ts | 187 + src/syslog.ts | 84 + src/ticket.ts | 257 + src/webApp.ts | 616 ++ src/webserver.ts | 86 + tsconfig.json | 115 + 205 files changed, 50399 insertions(+) create mode 100644 .eslintignore create mode 100644 .eslintrc.js create mode 100644 .github/workflows/ci-cd-implementation.yml create mode 100644 .gitignore create mode 100644 CODEOWNERS create mode 100644 CODE_OF_CONDUCT.md create mode 100644 License.md create mode 100644 README.md create mode 100644 docs/.nojekyll create mode 100644 docs/classes/alarms.Acknowledgement.md create mode 100644 docs/classes/alarms.Alarms.md create mode 100644 docs/classes/alarms.AlarmsAcknowledge.md create mode 100644 docs/classes/alarms.AlarmsAcknowledgeResponse.md create mode 100644 docs/classes/alarms.AlarmsBrowse.md create mode 100644 docs/classes/alarms.AlarmsBrowseResponse.md create mode 100644 docs/classes/alarms.EntryAlarm.md create mode 100644 docs/classes/alarms.Filters.md create mode 100644 docs/classes/api.ApiBrowse.md create mode 100644 docs/classes/api.ApiBrowseResponse.md create mode 100644 docs/classes/api.ApiBrowseTickets.md create mode 100644 docs/classes/api.ApiBrowseTicketsResponse.md create mode 100644 docs/classes/api.ApiChangePassword.md create mode 100644 docs/classes/api.ApiChangePasswordResponse.md create mode 100644 docs/classes/api.ApiCloseTickets.md create mode 100644 docs/classes/api.ApiCloseTicketsResponse.md create mode 100644 docs/classes/api.ApiGetAuthenticationMode.md create mode 100644 docs/classes/api.ApiGetAuthenticationModeResponse.md create mode 100644 docs/classes/api.ApiGetCertificateUrl.md create mode 100644 docs/classes/api.ApiGetCertificateUrlResponse.md create mode 100644 docs/classes/api.ApiGetPasswordPolicy.md create mode 100644 docs/classes/api.ApiGetPasswordPolicyResponse.md create mode 100644 docs/classes/api.ApiGetPermissions.md create mode 100644 docs/classes/api.ApiGetPermissionsResponse.md create mode 100644 docs/classes/api.ApiGetQuantityStructures.md create mode 100644 docs/classes/api.ApiGetQuantityStructuresResponse.md create mode 100644 docs/classes/api.ApiLogin.md create mode 100644 docs/classes/api.ApiLoginResponse.md create mode 100644 docs/classes/api.ApiLogout.md create mode 100644 docs/classes/api.ApiLogoutResponse.md create mode 100644 docs/classes/api.ApiPing.md create mode 100644 docs/classes/api.ApiPingResponse.md create mode 100644 docs/classes/api.ApiTicket.md create mode 100644 docs/classes/api.ApiVersion.md create mode 100644 docs/classes/api.ApiVersionResponse.md create mode 100644 docs/classes/api.CustomTicket.md create mode 100644 docs/classes/api.PasswordPolicy.md create mode 100644 docs/classes/api.QuantityStructure.md create mode 100644 docs/classes/datalogs.DataLogsDownloadAndClear.md create mode 100644 docs/classes/datalogs.DataLogsDownloadAndClearResponse.md create mode 100644 docs/classes/diagnosticbuffer.DiagnosticBufferBrowse.md create mode 100644 docs/classes/diagnosticbuffer.DiagnosticBufferBrowseResponse.md create mode 100644 docs/classes/diagnosticbuffer.DiagnosticBufferStructure.md create mode 100644 docs/classes/diagnosticbuffer.Entry.md create mode 100644 docs/classes/diagnosticbuffer.Event.md create mode 100644 docs/classes/diagnosticbuffer.Filters.md create mode 100644 docs/classes/failsafe.CPUResponse.md create mode 100644 docs/classes/failsafe.FailsafeReadParameters.md create mode 100644 docs/classes/failsafe.FailsafeReadParametersResponse.md create mode 100644 docs/classes/failsafe.FailsafeReadParametersStructure.md create mode 100644 docs/classes/failsafe.FailsafeReadRuntimeGroups.md create mode 100644 docs/classes/failsafe.FailsafeReadRuntimeGroupsResponse.md create mode 100644 docs/classes/failsafe.FailsafeReadRuntimeGroupsStructure.md create mode 100644 docs/classes/failsafe.ModuleResponse.md create mode 100644 docs/classes/files.FilesBrowse.md create mode 100644 docs/classes/files.FilesBrowseResponse.md create mode 100644 docs/classes/files.FilesCreate.md create mode 100644 docs/classes/files.FilesCreateDirectory.md create mode 100644 docs/classes/files.FilesCreateDirectoryResponse.md create mode 100644 docs/classes/files.FilesCreateResponse.md create mode 100644 docs/classes/files.FilesDelete.md create mode 100644 docs/classes/files.FilesDeleteDirectory.md create mode 100644 docs/classes/files.FilesDeleteDirectoryResponse.md create mode 100644 docs/classes/files.FilesDeleteResponse.md create mode 100644 docs/classes/files.FilesDownload.md create mode 100644 docs/classes/files.FilesDownloadResponse.md create mode 100644 docs/classes/files.FilesRename.md create mode 100644 docs/classes/files.FilesRenameResponse.md create mode 100644 docs/classes/files.Resources.md create mode 100644 docs/classes/plc.PlcCreateBackup.md create mode 100644 docs/classes/plc.PlcCreateBackupResponse.md create mode 100644 docs/classes/plc.PlcReadOperatingMode.md create mode 100644 docs/classes/plc.PlcReadOperatingModeResponse.md create mode 100644 docs/classes/plc.PlcReadSystemTime.md create mode 100644 docs/classes/plc.PlcReadSystemTimeResponse.md create mode 100644 docs/classes/plc.PlcReadTimeSettings.md create mode 100644 docs/classes/plc.PlcReadTimeSettingsResponse.md create mode 100644 docs/classes/plc.PlcRequestChangeOperatingMode.md create mode 100644 docs/classes/plc.PlcRequestChangeOperatingModeResponse.md create mode 100644 docs/classes/plc.PlcRestoreBackup.md create mode 100644 docs/classes/plc.PlcRestoreBackupResponse.md create mode 100644 docs/classes/plc.PlcSetSystemTime.md create mode 100644 docs/classes/plc.PlcSetSystemTimeResponse.md create mode 100644 docs/classes/plc.PlcSetTimeSettings.md create mode 100644 docs/classes/plc.PlcSetTimeSettingsResponse.md create mode 100644 docs/classes/plc.Rule.md create mode 100644 docs/classes/plc.RuleDst.md create mode 100644 docs/classes/plc.RuleStart.md create mode 100644 docs/classes/plc.RuleStd.md create mode 100644 docs/classes/plc.TimeSettings.md create mode 100644 docs/classes/plcprogram.PlcProgramBrowse.md create mode 100644 docs/classes/plcprogram.PlcProgramBrowseArrayData.md create mode 100644 docs/classes/plcprogram.PlcProgramBrowseResponse.md create mode 100644 docs/classes/plcprogram.PlcProgramBrowseVariable.md create mode 100644 docs/classes/plcprogram.PlcProgramDownloadProfilingData.md create mode 100644 docs/classes/plcprogram.PlcProgramDownloadProfilingDataResponse.md create mode 100644 docs/classes/plcprogram.PlcProgramRead.md create mode 100644 docs/classes/plcprogram.PlcProgramReadResponse.md create mode 100644 docs/classes/plcprogram.PlcProgramWrite.md create mode 100644 docs/classes/plcprogram.PlcProgramWriteResponse.md create mode 100644 docs/classes/project.Languages.md create mode 100644 docs/classes/project.ProjectLanguages.md create mode 100644 docs/classes/project.ProjectLanguagesResponse.md create mode 100644 docs/classes/request.JsonrpcBaseRequest.md create mode 100644 docs/classes/request.RequestConfig.md create mode 100644 docs/classes/response.JsonrpcBaseResponse.md create mode 100644 docs/classes/response.JsonrpcError.md create mode 100644 docs/classes/syslog.SyslogBrowse.md create mode 100644 docs/classes/syslog.SyslogBrowseResponse.md create mode 100644 docs/classes/syslog.SyslogBrowseStructure.md create mode 100644 docs/classes/syslog.SyslogData.md create mode 100644 docs/classes/ticket.ProxyTicketDownloadData.md create mode 100644 docs/classes/ticket.ProxyTicketUploadData.md create mode 100644 docs/classes/ticket.TicketDownloadData.md create mode 100644 docs/classes/ticket.TicketUploadData.md create mode 100644 docs/classes/webApp.Application.md create mode 100644 docs/classes/webApp.BrowseResourcesStructure.md create mode 100644 docs/classes/webApp.BrowseStructure.md create mode 100644 docs/classes/webApp.Resource.md create mode 100644 docs/classes/webApp.WebAppBrowse.md create mode 100644 docs/classes/webApp.WebAppBrowseResources.md create mode 100644 docs/classes/webApp.WebAppBrowseResourcesResponse.md create mode 100644 docs/classes/webApp.WebAppBrowseResponse.md create mode 100644 docs/classes/webApp.WebAppCreate.md create mode 100644 docs/classes/webApp.WebAppCreateResource.md create mode 100644 docs/classes/webApp.WebAppCreateResourceResponse.md create mode 100644 docs/classes/webApp.WebAppCreateResponse.md create mode 100644 docs/classes/webApp.WebAppDelete.md create mode 100644 docs/classes/webApp.WebAppDeleteResource.md create mode 100644 docs/classes/webApp.WebAppDeleteResourceResponse.md create mode 100644 docs/classes/webApp.WebAppDeleteResponse.md create mode 100644 docs/classes/webApp.WebAppDownloadResource.md create mode 100644 docs/classes/webApp.WebAppDownloadResourceResponse.md create mode 100644 docs/classes/webApp.WebAppRename.md create mode 100644 docs/classes/webApp.WebAppRenameResource.md create mode 100644 docs/classes/webApp.WebAppRenameResourceResponse.md create mode 100644 docs/classes/webApp.WebAppRenameResponse.md create mode 100644 docs/classes/webApp.WebAppSetDefaultPage.md create mode 100644 docs/classes/webApp.WebAppSetDefaultPageResponse.md create mode 100644 docs/classes/webApp.WebAppSetNotAuthorizedPage.md create mode 100644 docs/classes/webApp.WebAppSetNotAuthorizedPageResponse.md create mode 100644 docs/classes/webApp.WebAppSetNotFoundPage.md create mode 100644 docs/classes/webApp.WebAppSetNotFoundPageResponse.md create mode 100644 docs/classes/webApp.WebAppSetResourceETag.md create mode 100644 docs/classes/webApp.WebAppSetResourceETagResponse.md create mode 100644 docs/classes/webApp.WebAppSetResourceMediaType.md create mode 100644 docs/classes/webApp.WebAppSetResourceMediaTypeResponse.md create mode 100644 docs/classes/webApp.WebAppSetResourceModificationTime.md create mode 100644 docs/classes/webApp.WebAppSetResourceModificationTimeResponse.md create mode 100644 docs/classes/webApp.WebAppSetResourceVisibility.md create mode 100644 docs/classes/webApp.WebAppSetResourceVisibilityResponse.md create mode 100644 docs/classes/webApp.WebAppSetState.md create mode 100644 docs/classes/webApp.WebAppSetStateResponse.md create mode 100644 docs/classes/webserver.WebServerReadDefaultPage.md create mode 100644 docs/classes/webserver.WebServerReadDefaultPageResponse.md create mode 100644 docs/classes/webserver.WebServerSetDefaultPage.md create mode 100644 docs/classes/webserver.WebServerSetDefaultPageResponse.md create mode 100644 docs/enums/api.ApiTicketState.md create mode 100644 docs/enums/plc.PlcOpertingMode.md create mode 100644 docs/modules.md create mode 100644 docs/modules/alarms.md create mode 100644 docs/modules/api.md create mode 100644 docs/modules/datalogs.md create mode 100644 docs/modules/diagnosticbuffer.md create mode 100644 docs/modules/failsafe.md create mode 100644 docs/modules/files.md create mode 100644 docs/modules/index.md create mode 100644 docs/modules/plc.md create mode 100644 docs/modules/plcprogram.md create mode 100644 docs/modules/project.md create mode 100644 docs/modules/request.md create mode 100644 docs/modules/response.md create mode 100644 docs/modules/syslog.md create mode 100644 docs/modules/ticket.md create mode 100644 docs/modules/webApp.md create mode 100644 docs/modules/webserver.md create mode 100644 jest.config.js create mode 100644 package-lock.json create mode 100644 package.json create mode 100644 src/alarms.ts create mode 100644 src/api.ts create mode 100644 src/datalogs.ts create mode 100644 src/diagnosticbuffer.ts create mode 100644 src/failsafe.ts create mode 100644 src/files.ts create mode 100644 src/index.ts create mode 100644 src/plc.ts create mode 100644 src/plcprogram.ts create mode 100644 src/project.ts create mode 100644 src/request.ts create mode 100644 src/response.ts create mode 100644 src/syslog.ts create mode 100644 src/ticket.ts create mode 100644 src/webApp.ts create mode 100644 src/webserver.ts create mode 100644 tsconfig.json diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 0000000..7773828 --- /dev/null +++ b/.eslintignore @@ -0,0 +1 @@ +dist/ \ No newline at end of file diff --git a/.eslintrc.js b/.eslintrc.js new file mode 100644 index 0000000..1ce338d --- /dev/null +++ b/.eslintrc.js @@ -0,0 +1,24 @@ +module.exports = { + parser: '@typescript-eslint/parser', // Specifies the ESLint parser + extends: [ + 'eslint:recommended', + 'semistandard', + 'plugin:@typescript-eslint/recommended' // TypeScript-specific rules + ], + plugins: ['@typescript-eslint'], // Specifies the ESLint plugin for TypeScript + rules: { + + quotes: ['error', 'single'], // Use single quotes + semi: ['error', 'always'], // Enforce semicolons + 'no-multiple-empty-lines': ['error', { max: 1 }], // Allow at most one empty line + 'padded-blocks': ['off'], // Turn off padding for blocks + 'object-curly-spacing': ['error', 'always'], // Require space inside curly braces + camelcase: ['off'], // Turn off camelcase checks + 'prefer-const': ['error'], // Require const for variables that are never reassigned + 'no-trailing-spaces': ['error'], // Disallow trailing spaces + 'keyword-spacing': ['error', { before: true, after: true }], // Enforce spacing around keywords + 'eol-last': ['error', 'always'], // Require newline at the end of files + "@typescript-eslint/no-explicit-any": "off" + + } +}; diff --git a/.github/workflows/ci-cd-implementation.yml b/.github/workflows/ci-cd-implementation.yml new file mode 100644 index 0000000..e67a36c --- /dev/null +++ b/.github/workflows/ci-cd-implementation.yml @@ -0,0 +1,47 @@ +name: CI/CD Pipeline + +on: + push: + branches: + - main # Trigger on pushes on the main branch + tags: + - 'v*.*.*' # Trigger on version tags (e.g., v1.0.0) + pull_request: + branches: + - main # Trigger on pull requests to the main branch + + + + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v3 + + - name: Set up Node.js + uses: actions/setup-node@v3 + with: + node-version: '22' + + - name: Install dependencies + run: npm ci + + - name: Run lint + run: npm run lint + + # - name: Run tests + # run: npm test + + - name: Build + run: npm run build + + - name: Publish to npm + if: startsWith(github.ref, 'refs/tags/v') # Publish only for version tags + env: + NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}} # npm authentication token + run: | + npm config set @siemens:registry https://registry.npmjs.org/ + npm publish --access public \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7ee78a6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +node_modules/ +build/ +dist/ \ No newline at end of file diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..abf337c --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1 @@ +* @lopezfernandezjesus @kruegerfelix diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..5e87a99 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +tia-portal-applications.industry@siemens.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. \ No newline at end of file diff --git a/License.md b/License.md new file mode 100644 index 0000000..e9c8d04 --- /dev/null +++ b/License.md @@ -0,0 +1,20 @@ +MIT License + +Copyright (c) Siemens AG 2024 + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the “Software”), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..577f651 --- /dev/null +++ b/README.md @@ -0,0 +1,222 @@ +# S71500 Web API Client + +## Description +The S71500 Web API Client is a TypeScript library designed to interact with the SIMATIC S7 web server. It provides a set of functions to access various features and data from the server. + +## Features + +### Basic Functions +- **Login**: Allows users to log in to the system. +- **Get Permissions**: Retrieves permissions for the logged-in user. +- **Browse**: Enables browsing through available resources. +- **Version**: Retrieves the version information of the API. +- **Ping**: Checks the availability of the API. +- **Get Certificate URL**: Retrieves the URL for obtaining certificates. +- **Logout**: Logs out the current user. +- **Get Quantity Structures**: Retrieves quantity structures. +- **Change Password**: Allows users to change their passwords. +- **Get Password Policy**: Retrieves the password policy settings. +- **Get Authentication Mode**: Retrieves the authentication mode settings. + +*For more detailed information, please refer to the [documentation](/docs/modules/api.md).* + +### Setting Web Server Defaults +- **Set Default Page**: Sets the default page for the web server. +- **Read Default Page**: Retrieves the default page settings. + +*For more detailed information, please refer to the documentation.* + +### Ticket Mechanism +- **Browse Tickets**: Allows browsing through available tickets. +- **Close Ticket**: Closes a specific ticket. + +*For more detailed information, please refer to the [documentation](/docs/modules/ticket.md).* + +### Reading and Writing Process Data +- **Read**: Reads process data. +- **Write**: Writes process data. +- **Download Profiling Data**: Downloads profiling data. +- **Browse**: Browses through available PLC programs. + +*For more detailed information, please refer to the [documentation](/docs/modules/plcprogram.md).* + +### Reading and Changing Operating Mode +- **Read Operating Mode**: Reads the operating mode. +- **Request Change Operating Mode**: Requests a change in the operating mode. +- **Read Mode Selector State**: Reads the mode selector state. + +*For more detailed information, please refer to the [documentation](/docs/modules/plc.md).* + +### Performing Time Settings +- **Read System Time**: Reads the system time. +- **Set System Time**: Sets the system time. +- **Read Time Settings**: Reads time settings. +- **Set Time Settings**: Sets time settings. + +*For more detailed information, please refer to the [documentation](/docs/modules/plc.md).* + +### Reading Diagnostics and Service Data +- **Browse Alarms**: Browses through available alarms. +- **Acknowledge Alarms**: Acknowledges alarms. +- **Browse Syslog**: Browses through syslog entries. +- **Browse Diagnostic Buffer**: Browses through diagnostic buffer entries. +- **Download Service Data**: Downloads service data. +- **Read Project Languages**: Reads project languages. + +*For more detailed information, please refer to the [documentation](/docs/modules/syslog.md).* + +### Backing up and Restoring Configuration +- **Create Backup**: Creates a backup of the configuration. +- **Restore Backup**: Restores a backup of the configuration. + +*For more detailed information, please refer to the [documentation](/docs/modules/plc.md).* + +### Accessing SIMATIC Memory Card Contents +- **Browse Files**: Browses through available files. +- **Download Files**: Downloads files. +- **Create File**: Creates a new file. +- **Rename File**: Renames a file. +- **Delete File**: Deletes a file. +- **Create Directory**: Creates a new directory. +- **Delete Directory**: Deletes a directory. +- **Download and Clear Data Logs**: Downloads and clears data logs. + +*For more detailed information, please refer to the [documentation](/docs/modules/files.md).* + +### Reading Information from SIMATIC Safety +- **Read Runtime Groups**: Reads runtime groups. +- **Read Parameters**: Reads parameters. + +*For more detailed information, please refer to the [documentation](/docs/modules/failsafe.md).* + +### Web Application Management +- **Create Web App**: Creates a new web application. +- **Delete Web App**: Deletes a web application. +- **Rename Web App**: Renames a web application. +- **Browse Web App**: Browses through available web applications. +- **Set Web App State**: Sets the state of a web application. +- **Set Default Page for Web App**: Sets the default page for a web application. +- **Set Not Found Page for Web App**: Sets the not found page for a web application. +- **Set Not Authorized Page for Web App**: Sets the not authorized page for a web application. +- **Browse Web App Resources**: Browses through available resources for a web application. +- **Create Web App Resource**: Creates a new resource for a web application. +- **Delete Web App Resource**: Deletes a resource for a web application. +- **Rename Web App Resource**: Renames a resource for a web application. +- **Download Web App Resource**: Downloads a resource for a web application. +- **Set Resource Visibility for Web App**: Sets the visibility of a resource for a web application. +- **Set Resource ETag for Web App**: Sets the ETag of a resource for a web application. +- **Set Resource Media Type for Web App**: Sets the media type of a resource for a web application. +- **Set Resource Modification Time for Web App**: Sets the modification time of a resource for a web application. + +*For more detailed information, please refer to the [documentation](/docs/modules/webApp.md).* + +## Usage +To use the S71500 Web API Client, you first need to install the package via npm: + +```bash +npm install @siemens/simatic-s7-webserver-api + +``` + +**WARNING - DEPENDENCIES** +Note on ESLint Version Compatibility +When running npm install, you may encounter warnings related to ESLint and its dependencies. This is due to certain devDependencies, such as eslint-config-semistandard and eslint-config-standard, not fully supporting ESLint 9.0.0 yet. These warnings are expected and will persist until the necessary updates are made for compatibility. + +To ensure stability, this project is currently using ESLint version 8.57.1 and related configurations. Once support for ESLint 9.0.0 is available across all dependencies, the project will be updated accordingly. + +Feel free to follow the progress of updates from these packages to keep track of when ESLint 9.0.0 becomes fully compatible with these configurations. + +## Example + +In this example, it is shown how to interact with the server using the library. Here, we will do a login with an user previously created in the TIA Portal project with administrative access. + +After a succesfull login, the server will return a token that allows the user to call another methods. In the next lines, a search into the Web Applications is done: + +```typescript +import * as client from "@siemens/simatic-s7-webserver-api"; +import * as fs from "fs"; + +const config = new client.request.RequestConfig(); +config.address = "192.168.0.1"; //IP address of the PLC +config.protocol = "https"; // Communication protocol +config.verifyTls = true; // Verify TLS Server Certificate. +config.plcCertificate = fs.readFileSync("path/to/certificate.crt"); //Update with your path to the plc certificate. + +async function example() { + const login = await new client.api.ApiLogin( + config, + "Admin", + "12345678Aa", + false + ).execute(); + + if (login) { + const token = login.result; + const searchApps = await new client.webapp.WebAppBrowse(config).execute(); + + if (searchApps && searchApps.result) { + console.log("Max Applications:", searchApps.result.max_applications); + console.log("Applications:"); + for (const resource of searchApps.result.applications) { + console.log(resource); + } + } + } +} +``` + +**WARNING - SECURITY DISCLAIMER** + +If you do not have downloaded the PLC certificate or you don't have access to it, you can disable the verifyTls configuration setting it to 'false'. This will allow you to communicate with the server without verification. Remember that this do not follow the security best practices. + +After a succesfull communication, the server will return an object compound of various terms: + +- **kind**: an string available to read and that identifies the response when you have multiple requests. + +- **id**: the id number of the response, it matches the same id as the request. + +- **error**: when an error happens during the communication it will return a message and a code that identifies the error. Check the official WebServer documentation to see the error codes. + +- **result**: it depends on the method, this attribute of the object can have different structure. The methods can return a boolean, a string (that is the case of the ApiLogin), an array or another object (that is the case of the WebAppBrowse). + +Here it is shown what returns the example in the console: + +``` +Max Applications: 4 +Applications: +Application {name: 'ViewOfThings', state: 'enabled', type: 'vot'} +``` + +## Bulk requests + +To increase the performance of an application you can use a bulk request that with a single header it can perform multiple single requests with different purposes. The goal here is to reduce the communication load of the PLC. In the example provided there are 40 access to read values stored in a DB called DataBuffer with a single bulk request: + +```typescript +const paramsArray = []; + +// Prepare each parameter set for value and timestamp +for (let i = 0; i < 20; i++) { + const valueVar = `"DataBuffer".data[${i}].value`; + const timestampVar = `"DataBuffer".data[${i}].timeStamp`; + + paramsArray.push({ var: valueVar, mode: "simple" }); + paramsArray.push({ var: timestampVar, mode: "simple" }); +} + +try { + const responses = await new PlcProgramRead(config, authToken, "").bulkExecute( + paramsArray + ); + if (responses) { + this.dataStructArray = this.parseResponse(responses); + } +} catch (error) { + console.error("Error reading data from PLC:", error); +} +``` + +## License + +The S71500 Web API Client is licensed under the MIT License, which means that you are free to get and use it for commercial and non-commercial purposes as long as you fulfill its conditions. + +See the [LICENSE.md](LICENSE.md) file for more details. diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e2ac661 --- /dev/null +++ b/docs/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/classes/alarms.Acknowledgement.md b/docs/classes/alarms.Acknowledgement.md new file mode 100644 index 0000000..2432f9c --- /dev/null +++ b/docs/classes/alarms.Acknowledgement.md @@ -0,0 +1,46 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [alarms](../modules/alarms.md) / Acknowledgement + +# Class: Acknowledgement + +[alarms](../modules/alarms.md).Acknowledgement + +## Table of contents + +### Constructors + +- [constructor](alarms.Acknowledgement.md#constructor) + +### Properties + +- [state](alarms.Acknowledgement.md#state) +- [timestamp](alarms.Acknowledgement.md#timestamp) + +## Constructors + +### constructor + +• **new Acknowledgement**(): [`Acknowledgement`](alarms.Acknowledgement.md) + +#### Returns + +[`Acknowledgement`](alarms.Acknowledgement.md) + +## Properties + +### state + +• **state**: `string` = `''` + +#### Defined in + +alarms.ts:10 + +___ + +### timestamp + +• **timestamp**: `string` = `''` + +#### Defined in + +alarms.ts:11 diff --git a/docs/classes/alarms.Alarms.md b/docs/classes/alarms.Alarms.md new file mode 100644 index 0000000..437b293 --- /dev/null +++ b/docs/classes/alarms.Alarms.md @@ -0,0 +1,79 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [alarms](../modules/alarms.md) / Alarms + +# Class: Alarms + +[alarms](../modules/alarms.md).Alarms + +## Table of contents + +### Constructors + +- [constructor](alarms.Alarms.md#constructor) + +### Properties + +- [count\_current](alarms.Alarms.md#count_current) +- [count\_max](alarms.Alarms.md#count_max) +- [entries](alarms.Alarms.md#entries) +- [language](alarms.Alarms.md#language) +- [last\_modified](alarms.Alarms.md#last_modified) + +## Constructors + +### constructor + +• **new Alarms**(): [`Alarms`](alarms.Alarms.md) + +#### Returns + +[`Alarms`](alarms.Alarms.md) + +## Properties + +### count\_current + +• **count\_current**: `number` = `0` + +#### Defined in + +alarms.ts:29 + +___ + +### count\_max + +• **count\_max**: `number` = `0` + +#### Defined in + +alarms.ts:30 + +___ + +### entries + +• `Optional` **entries**: [`EntryAlarm`](alarms.EntryAlarm.md)[] + +#### Defined in + +alarms.ts:31 + +___ + +### language + +• `Optional` **language**: `string` + +#### Defined in + +alarms.ts:27 + +___ + +### last\_modified + +• **last\_modified**: `string` = `''` + +#### Defined in + +alarms.ts:28 diff --git a/docs/classes/alarms.AlarmsAcknowledge.md b/docs/classes/alarms.AlarmsAcknowledge.md new file mode 100644 index 0000000..aff0edb --- /dev/null +++ b/docs/classes/alarms.AlarmsAcknowledge.md @@ -0,0 +1,383 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [alarms](../modules/alarms.md) / AlarmsAcknowledge + +# Class: AlarmsAcknowledge + +[alarms](../modules/alarms.md).AlarmsAcknowledge + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`AlarmsAcknowledge`** + +## Table of contents + +### Constructors + +- [constructor](alarms.AlarmsAcknowledge.md#constructor) + +### Properties + +- [address](alarms.AlarmsAcknowledge.md#address) +- [method](alarms.AlarmsAcknowledge.md#method) +- [params](alarms.AlarmsAcknowledge.md#params) +- [plcCertificate](alarms.AlarmsAcknowledge.md#plccertificate) +- [protocol](alarms.AlarmsAcknowledge.md#protocol) +- [response](alarms.AlarmsAcknowledge.md#response) +- [token](alarms.AlarmsAcknowledge.md#token) +- [verifyTls](alarms.AlarmsAcknowledge.md#verifytls) + +### Methods + +- [\_\_str\_\_](alarms.AlarmsAcknowledge.md#__str__) +- [body](alarms.AlarmsAcknowledge.md#body) +- [execute](alarms.AlarmsAcknowledge.md#execute) +- [format\_response](alarms.AlarmsAcknowledge.md#format_response) +- [gethttpsAgent](alarms.AlarmsAcknowledge.md#gethttpsagent) +- [headers](alarms.AlarmsAcknowledge.md#headers) +- [parse](alarms.AlarmsAcknowledge.md#parse) +- [request](alarms.AlarmsAcknowledge.md#request) +- [url](alarms.AlarmsAcknowledge.md#url) + +## Constructors + +### constructor + +• **new AlarmsAcknowledge**(`config`, `token`, `id`): [`AlarmsAcknowledge`](alarms.AlarmsAcknowledge.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `id` | `string` | + +#### Returns + +[`AlarmsAcknowledge`](alarms.AlarmsAcknowledge.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +alarms.ts:142 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`AlarmsAcknowledgeResponse`](alarms.AlarmsAcknowledgeResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`AlarmsAcknowledgeResponse`](alarms.AlarmsAcknowledgeResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +alarms.ts:148 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/alarms.AlarmsAcknowledgeResponse.md b/docs/classes/alarms.AlarmsAcknowledgeResponse.md new file mode 100644 index 0000000..f691328 --- /dev/null +++ b/docs/classes/alarms.AlarmsAcknowledgeResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [alarms](../modules/alarms.md) / AlarmsAcknowledgeResponse + +# Class: AlarmsAcknowledgeResponse + +[alarms](../modules/alarms.md).AlarmsAcknowledgeResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`AlarmsAcknowledgeResponse`** + +## Table of contents + +### Constructors + +- [constructor](alarms.AlarmsAcknowledgeResponse.md#constructor) + +### Properties + +- [error](alarms.AlarmsAcknowledgeResponse.md#error) +- [id](alarms.AlarmsAcknowledgeResponse.md#id) +- [kind](alarms.AlarmsAcknowledgeResponse.md#kind) +- [result](alarms.AlarmsAcknowledgeResponse.md#result) + +### Methods + +- [\_\_str\_\_](alarms.AlarmsAcknowledgeResponse.md#__str__) +- [is\_error](alarms.AlarmsAcknowledgeResponse.md#is_error) +- [parse](alarms.AlarmsAcknowledgeResponse.md#parse) + +## Constructors + +### constructor + +• **new AlarmsAcknowledgeResponse**(): [`AlarmsAcknowledgeResponse`](alarms.AlarmsAcknowledgeResponse.md) + +#### Returns + +[`AlarmsAcknowledgeResponse`](alarms.AlarmsAcknowledgeResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +alarms.ts:166 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `Boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +alarms.ts:165 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/alarms.AlarmsBrowse.md b/docs/classes/alarms.AlarmsBrowse.md new file mode 100644 index 0000000..6ecd94d --- /dev/null +++ b/docs/classes/alarms.AlarmsBrowse.md @@ -0,0 +1,386 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [alarms](../modules/alarms.md) / AlarmsBrowse + +# Class: AlarmsBrowse + +[alarms](../modules/alarms.md).AlarmsBrowse + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`AlarmsBrowse`** + +## Table of contents + +### Constructors + +- [constructor](alarms.AlarmsBrowse.md#constructor) + +### Properties + +- [address](alarms.AlarmsBrowse.md#address) +- [method](alarms.AlarmsBrowse.md#method) +- [params](alarms.AlarmsBrowse.md#params) +- [plcCertificate](alarms.AlarmsBrowse.md#plccertificate) +- [protocol](alarms.AlarmsBrowse.md#protocol) +- [response](alarms.AlarmsBrowse.md#response) +- [token](alarms.AlarmsBrowse.md#token) +- [verifyTls](alarms.AlarmsBrowse.md#verifytls) + +### Methods + +- [\_\_str\_\_](alarms.AlarmsBrowse.md#__str__) +- [body](alarms.AlarmsBrowse.md#body) +- [execute](alarms.AlarmsBrowse.md#execute) +- [format\_response](alarms.AlarmsBrowse.md#format_response) +- [gethttpsAgent](alarms.AlarmsBrowse.md#gethttpsagent) +- [headers](alarms.AlarmsBrowse.md#headers) +- [parse](alarms.AlarmsBrowse.md#parse) +- [request](alarms.AlarmsBrowse.md#request) +- [url](alarms.AlarmsBrowse.md#url) + +## Constructors + +### constructor + +• **new AlarmsBrowse**(`config`, `token`, `language`, `count?`, `alarm_id?`, `filters?`): [`AlarmsBrowse`](alarms.AlarmsBrowse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `language` | `string` | +| `count?` | `number` | +| `alarm_id?` | `string` | +| `filters?` | [`Filters`](alarms.Filters.md) | + +#### Returns + +[`AlarmsBrowse`](alarms.AlarmsBrowse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +alarms.ts:34 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`AlarmsBrowseResponse`](alarms.AlarmsBrowseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`AlarmsBrowseResponse`](alarms.AlarmsBrowseResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +alarms.ts:51 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/alarms.AlarmsBrowseResponse.md b/docs/classes/alarms.AlarmsBrowseResponse.md new file mode 100644 index 0000000..8a38260 --- /dev/null +++ b/docs/classes/alarms.AlarmsBrowseResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [alarms](../modules/alarms.md) / AlarmsBrowseResponse + +# Class: AlarmsBrowseResponse + +[alarms](../modules/alarms.md).AlarmsBrowseResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`AlarmsBrowseResponse`** + +## Table of contents + +### Constructors + +- [constructor](alarms.AlarmsBrowseResponse.md#constructor) + +### Properties + +- [error](alarms.AlarmsBrowseResponse.md#error) +- [id](alarms.AlarmsBrowseResponse.md#id) +- [kind](alarms.AlarmsBrowseResponse.md#kind) +- [result](alarms.AlarmsBrowseResponse.md#result) + +### Methods + +- [\_\_str\_\_](alarms.AlarmsBrowseResponse.md#__str__) +- [is\_error](alarms.AlarmsBrowseResponse.md#is_error) +- [parse](alarms.AlarmsBrowseResponse.md#parse) + +## Constructors + +### constructor + +• **new AlarmsBrowseResponse**(): [`AlarmsBrowseResponse`](alarms.AlarmsBrowseResponse.md) + +#### Returns + +[`AlarmsBrowseResponse`](alarms.AlarmsBrowseResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +alarms.ts:136 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: [`Alarms`](alarms.Alarms.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +alarms.ts:135 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/alarms.EntryAlarm.md b/docs/classes/alarms.EntryAlarm.md new file mode 100644 index 0000000..a3308d6 --- /dev/null +++ b/docs/classes/alarms.EntryAlarm.md @@ -0,0 +1,134 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [alarms](../modules/alarms.md) / EntryAlarm + +# Class: EntryAlarm + +[alarms](../modules/alarms.md).EntryAlarm + +## Table of contents + +### Constructors + +- [constructor](alarms.EntryAlarm.md#constructor) + +### Properties + +- [acknowledgement](alarms.EntryAlarm.md#acknowledgement) +- [alarm\_number](alarms.EntryAlarm.md#alarm_number) +- [alarm\_text](alarms.EntryAlarm.md#alarm_text) +- [hwid](alarms.EntryAlarm.md#hwid) +- [id](alarms.EntryAlarm.md#id) +- [info\_text](alarms.EntryAlarm.md#info_text) +- [producer](alarms.EntryAlarm.md#producer) +- [status](alarms.EntryAlarm.md#status) +- [text\_inconsistent](alarms.EntryAlarm.md#text_inconsistent) +- [timestamp](alarms.EntryAlarm.md#timestamp) + +## Constructors + +### constructor + +• **new EntryAlarm**(): [`EntryAlarm`](alarms.EntryAlarm.md) + +#### Returns + +[`EntryAlarm`](alarms.EntryAlarm.md) + +## Properties + +### acknowledgement + +• `Optional` **acknowledgement**: [`Acknowledgement`](alarms.Acknowledgement.md) + +#### Defined in + +alarms.ts:21 + +___ + +### alarm\_number + +• **alarm\_number**: `number` = `0` + +#### Defined in + +alarms.ts:16 + +___ + +### alarm\_text + +• **alarm\_text**: `string` = `''` + +#### Defined in + +alarms.ts:22 + +___ + +### hwid + +• `Optional` **hwid**: `number` + +#### Defined in + +alarms.ts:20 + +___ + +### id + +• **id**: `string` = `''` + +#### Defined in + +alarms.ts:15 + +___ + +### info\_text + +• **info\_text**: `string` = `''` + +#### Defined in + +alarms.ts:23 + +___ + +### producer + +• **producer**: `string` = `''` + +#### Defined in + +alarms.ts:19 + +___ + +### status + +• **status**: `string` = `''` + +#### Defined in + +alarms.ts:17 + +___ + +### text\_inconsistent + +• `Optional` **text\_inconsistent**: `boolean` + +#### Defined in + +alarms.ts:24 + +___ + +### timestamp + +• **timestamp**: `string` = `''` + +#### Defined in + +alarms.ts:18 diff --git a/docs/classes/alarms.Filters.md b/docs/classes/alarms.Filters.md new file mode 100644 index 0000000..982fc8f --- /dev/null +++ b/docs/classes/alarms.Filters.md @@ -0,0 +1,46 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [alarms](../modules/alarms.md) / Filters + +# Class: Filters + +[alarms](../modules/alarms.md).Filters + +## Table of contents + +### Constructors + +- [constructor](alarms.Filters.md#constructor) + +### Properties + +- [attributes](alarms.Filters.md#attributes) +- [mode](alarms.Filters.md#mode) + +## Constructors + +### constructor + +• **new Filters**(): [`Filters`](alarms.Filters.md) + +#### Returns + +[`Filters`](alarms.Filters.md) + +## Properties + +### attributes + +• **attributes**: `string`[] = `[]` + +#### Defined in + +alarms.ts:7 + +___ + +### mode + +• **mode**: `string` = `""` + +#### Defined in + +alarms.ts:6 diff --git a/docs/classes/api.ApiBrowse.md b/docs/classes/api.ApiBrowse.md new file mode 100644 index 0000000..5804295 --- /dev/null +++ b/docs/classes/api.ApiBrowse.md @@ -0,0 +1,381 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiBrowse + +# Class: ApiBrowse + +[api](../modules/api.md).ApiBrowse + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`ApiBrowse`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiBrowse.md#constructor) + +### Properties + +- [address](api.ApiBrowse.md#address) +- [method](api.ApiBrowse.md#method) +- [params](api.ApiBrowse.md#params) +- [plcCertificate](api.ApiBrowse.md#plccertificate) +- [protocol](api.ApiBrowse.md#protocol) +- [response](api.ApiBrowse.md#response) +- [token](api.ApiBrowse.md#token) +- [verifyTls](api.ApiBrowse.md#verifytls) + +### Methods + +- [\_\_str\_\_](api.ApiBrowse.md#__str__) +- [body](api.ApiBrowse.md#body) +- [execute](api.ApiBrowse.md#execute) +- [format\_response](api.ApiBrowse.md#format_response) +- [gethttpsAgent](api.ApiBrowse.md#gethttpsagent) +- [headers](api.ApiBrowse.md#headers) +- [parse](api.ApiBrowse.md#parse) +- [request](api.ApiBrowse.md#request) +- [url](api.ApiBrowse.md#url) + +## Constructors + +### constructor + +• **new ApiBrowse**(`config`): [`ApiBrowse`](api.ApiBrowse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | + +#### Returns + +[`ApiBrowse`](api.ApiBrowse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +api.ts:75 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`ApiBrowseResponse`](api.ApiBrowseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`ApiBrowseResponse`](api.ApiBrowseResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +api.ts:80 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/api.ApiBrowseResponse.md b/docs/classes/api.ApiBrowseResponse.md new file mode 100644 index 0000000..fc5775b --- /dev/null +++ b/docs/classes/api.ApiBrowseResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiBrowseResponse + +# Class: ApiBrowseResponse + +[api](../modules/api.md).ApiBrowseResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`ApiBrowseResponse`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiBrowseResponse.md#constructor) + +### Properties + +- [error](api.ApiBrowseResponse.md#error) +- [id](api.ApiBrowseResponse.md#id) +- [kind](api.ApiBrowseResponse.md#kind) +- [result](api.ApiBrowseResponse.md#result) + +### Methods + +- [\_\_str\_\_](api.ApiBrowseResponse.md#__str__) +- [is\_error](api.ApiBrowseResponse.md#is_error) +- [parse](api.ApiBrowseResponse.md#parse) + +## Constructors + +### constructor + +• **new ApiBrowseResponse**(): [`ApiBrowseResponse`](api.ApiBrowseResponse.md) + +#### Returns + +[`ApiBrowseResponse`](api.ApiBrowseResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +api.ts:108 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `string`[] + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +api.ts:107 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/api.ApiBrowseTickets.md b/docs/classes/api.ApiBrowseTickets.md new file mode 100644 index 0000000..5b65f17 --- /dev/null +++ b/docs/classes/api.ApiBrowseTickets.md @@ -0,0 +1,383 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiBrowseTickets + +# Class: ApiBrowseTickets + +[api](../modules/api.md).ApiBrowseTickets + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`ApiBrowseTickets`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiBrowseTickets.md#constructor) + +### Properties + +- [address](api.ApiBrowseTickets.md#address) +- [method](api.ApiBrowseTickets.md#method) +- [params](api.ApiBrowseTickets.md#params) +- [plcCertificate](api.ApiBrowseTickets.md#plccertificate) +- [protocol](api.ApiBrowseTickets.md#protocol) +- [response](api.ApiBrowseTickets.md#response) +- [token](api.ApiBrowseTickets.md#token) +- [verifyTls](api.ApiBrowseTickets.md#verifytls) + +### Methods + +- [\_\_str\_\_](api.ApiBrowseTickets.md#__str__) +- [body](api.ApiBrowseTickets.md#body) +- [execute](api.ApiBrowseTickets.md#execute) +- [format\_response](api.ApiBrowseTickets.md#format_response) +- [gethttpsAgent](api.ApiBrowseTickets.md#gethttpsagent) +- [headers](api.ApiBrowseTickets.md#headers) +- [parse](api.ApiBrowseTickets.md#parse) +- [request](api.ApiBrowseTickets.md#request) +- [url](api.ApiBrowseTickets.md#url) + +## Constructors + +### constructor + +• **new ApiBrowseTickets**(`config`, `token`, `id?`): [`ApiBrowseTickets`](api.ApiBrowseTickets.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `id?` | `string` | + +#### Returns + +[`ApiBrowseTickets`](api.ApiBrowseTickets.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +api.ts:276 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`ApiBrowseTicketsResponse`](api.ApiBrowseTicketsResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`ApiBrowseTicketsResponse`](api.ApiBrowseTicketsResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +api.ts:284 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/api.ApiBrowseTicketsResponse.md b/docs/classes/api.ApiBrowseTicketsResponse.md new file mode 100644 index 0000000..76818cb --- /dev/null +++ b/docs/classes/api.ApiBrowseTicketsResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiBrowseTicketsResponse + +# Class: ApiBrowseTicketsResponse + +[api](../modules/api.md).ApiBrowseTicketsResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`ApiBrowseTicketsResponse`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiBrowseTicketsResponse.md#constructor) + +### Properties + +- [error](api.ApiBrowseTicketsResponse.md#error) +- [id](api.ApiBrowseTicketsResponse.md#id) +- [kind](api.ApiBrowseTicketsResponse.md#kind) +- [result](api.ApiBrowseTicketsResponse.md#result) + +### Methods + +- [\_\_str\_\_](api.ApiBrowseTicketsResponse.md#__str__) +- [is\_error](api.ApiBrowseTicketsResponse.md#is_error) +- [parse](api.ApiBrowseTicketsResponse.md#parse) + +## Constructors + +### constructor + +• **new ApiBrowseTicketsResponse**(): [`ApiBrowseTicketsResponse`](api.ApiBrowseTicketsResponse.md) + +#### Returns + +[`ApiBrowseTicketsResponse`](api.ApiBrowseTicketsResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +api.ts:342 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: [`CustomTicket`](api.CustomTicket.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +api.ts:341 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/api.ApiChangePassword.md b/docs/classes/api.ApiChangePassword.md new file mode 100644 index 0000000..61144f7 --- /dev/null +++ b/docs/classes/api.ApiChangePassword.md @@ -0,0 +1,385 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiChangePassword + +# Class: ApiChangePassword + +[api](../modules/api.md).ApiChangePassword + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`ApiChangePassword`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiChangePassword.md#constructor) + +### Properties + +- [address](api.ApiChangePassword.md#address) +- [method](api.ApiChangePassword.md#method) +- [params](api.ApiChangePassword.md#params) +- [plcCertificate](api.ApiChangePassword.md#plccertificate) +- [protocol](api.ApiChangePassword.md#protocol) +- [response](api.ApiChangePassword.md#response) +- [token](api.ApiChangePassword.md#token) +- [verifyTls](api.ApiChangePassword.md#verifytls) + +### Methods + +- [\_\_str\_\_](api.ApiChangePassword.md#__str__) +- [body](api.ApiChangePassword.md#body) +- [execute](api.ApiChangePassword.md#execute) +- [format\_response](api.ApiChangePassword.md#format_response) +- [gethttpsAgent](api.ApiChangePassword.md#gethttpsagent) +- [headers](api.ApiChangePassword.md#headers) +- [parse](api.ApiChangePassword.md#parse) +- [request](api.ApiChangePassword.md#request) +- [url](api.ApiChangePassword.md#url) + +## Constructors + +### constructor + +• **new ApiChangePassword**(`config`, `token`, `username`, `password`, `new_password`): [`ApiChangePassword`](api.ApiChangePassword.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `username` | `string` | +| `password` | `string` | +| `new_password` | `string` | + +#### Returns + +[`ApiChangePassword`](api.ApiChangePassword.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +api.ts:414 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`ApiChangePasswordResponse`](api.ApiChangePasswordResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`ApiChangePasswordResponse`](api.ApiChangePasswordResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +api.ts:421 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/api.ApiChangePasswordResponse.md b/docs/classes/api.ApiChangePasswordResponse.md new file mode 100644 index 0000000..05ae2f5 --- /dev/null +++ b/docs/classes/api.ApiChangePasswordResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiChangePasswordResponse + +# Class: ApiChangePasswordResponse + +[api](../modules/api.md).ApiChangePasswordResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`ApiChangePasswordResponse`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiChangePasswordResponse.md#constructor) + +### Properties + +- [error](api.ApiChangePasswordResponse.md#error) +- [id](api.ApiChangePasswordResponse.md#id) +- [kind](api.ApiChangePasswordResponse.md#kind) +- [result](api.ApiChangePasswordResponse.md#result) + +### Methods + +- [\_\_str\_\_](api.ApiChangePasswordResponse.md#__str__) +- [is\_error](api.ApiChangePasswordResponse.md#is_error) +- [parse](api.ApiChangePasswordResponse.md#parse) + +## Constructors + +### constructor + +• **new ApiChangePasswordResponse**(): [`ApiChangePasswordResponse`](api.ApiChangePasswordResponse.md) + +#### Returns + +[`ApiChangePasswordResponse`](api.ApiChangePasswordResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +api.ts:437 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +api.ts:436 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/api.ApiCloseTickets.md b/docs/classes/api.ApiCloseTickets.md new file mode 100644 index 0000000..1857ebc --- /dev/null +++ b/docs/classes/api.ApiCloseTickets.md @@ -0,0 +1,383 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiCloseTickets + +# Class: ApiCloseTickets + +[api](../modules/api.md).ApiCloseTickets + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`ApiCloseTickets`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiCloseTickets.md#constructor) + +### Properties + +- [address](api.ApiCloseTickets.md#address) +- [method](api.ApiCloseTickets.md#method) +- [params](api.ApiCloseTickets.md#params) +- [plcCertificate](api.ApiCloseTickets.md#plccertificate) +- [protocol](api.ApiCloseTickets.md#protocol) +- [response](api.ApiCloseTickets.md#response) +- [token](api.ApiCloseTickets.md#token) +- [verifyTls](api.ApiCloseTickets.md#verifytls) + +### Methods + +- [\_\_str\_\_](api.ApiCloseTickets.md#__str__) +- [body](api.ApiCloseTickets.md#body) +- [execute](api.ApiCloseTickets.md#execute) +- [format\_response](api.ApiCloseTickets.md#format_response) +- [gethttpsAgent](api.ApiCloseTickets.md#gethttpsagent) +- [headers](api.ApiCloseTickets.md#headers) +- [parse](api.ApiCloseTickets.md#parse) +- [request](api.ApiCloseTickets.md#request) +- [url](api.ApiCloseTickets.md#url) + +## Constructors + +### constructor + +• **new ApiCloseTickets**(`config`, `token`, `id`): [`ApiCloseTickets`](api.ApiCloseTickets.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `id` | `string` | + +#### Returns + +[`ApiCloseTickets`](api.ApiCloseTickets.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +api.ts:236 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`ApiCloseTicketsResponse`](api.ApiCloseTicketsResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`ApiCloseTicketsResponse`](api.ApiCloseTicketsResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +api.ts:241 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/api.ApiCloseTicketsResponse.md b/docs/classes/api.ApiCloseTicketsResponse.md new file mode 100644 index 0000000..d35f418 --- /dev/null +++ b/docs/classes/api.ApiCloseTicketsResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiCloseTicketsResponse + +# Class: ApiCloseTicketsResponse + +[api](../modules/api.md).ApiCloseTicketsResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`ApiCloseTicketsResponse`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiCloseTicketsResponse.md#constructor) + +### Properties + +- [error](api.ApiCloseTicketsResponse.md#error) +- [id](api.ApiCloseTicketsResponse.md#id) +- [kind](api.ApiCloseTicketsResponse.md#kind) +- [result](api.ApiCloseTicketsResponse.md#result) + +### Methods + +- [\_\_str\_\_](api.ApiCloseTicketsResponse.md#__str__) +- [is\_error](api.ApiCloseTicketsResponse.md#is_error) +- [parse](api.ApiCloseTicketsResponse.md#parse) + +## Constructors + +### constructor + +• **new ApiCloseTicketsResponse**(): [`ApiCloseTicketsResponse`](api.ApiCloseTicketsResponse.md) + +#### Returns + +[`ApiCloseTicketsResponse`](api.ApiCloseTicketsResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +api.ts:258 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +api.ts:257 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/api.ApiGetAuthenticationMode.md b/docs/classes/api.ApiGetAuthenticationMode.md new file mode 100644 index 0000000..a8ed4c0 --- /dev/null +++ b/docs/classes/api.ApiGetAuthenticationMode.md @@ -0,0 +1,381 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiGetAuthenticationMode + +# Class: ApiGetAuthenticationMode + +[api](../modules/api.md).ApiGetAuthenticationMode + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`ApiGetAuthenticationMode`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiGetAuthenticationMode.md#constructor) + +### Properties + +- [address](api.ApiGetAuthenticationMode.md#address) +- [method](api.ApiGetAuthenticationMode.md#method) +- [params](api.ApiGetAuthenticationMode.md#params) +- [plcCertificate](api.ApiGetAuthenticationMode.md#plccertificate) +- [protocol](api.ApiGetAuthenticationMode.md#protocol) +- [response](api.ApiGetAuthenticationMode.md#response) +- [token](api.ApiGetAuthenticationMode.md#token) +- [verifyTls](api.ApiGetAuthenticationMode.md#verifytls) + +### Methods + +- [\_\_str\_\_](api.ApiGetAuthenticationMode.md#__str__) +- [body](api.ApiGetAuthenticationMode.md#body) +- [execute](api.ApiGetAuthenticationMode.md#execute) +- [format\_response](api.ApiGetAuthenticationMode.md#format_response) +- [gethttpsAgent](api.ApiGetAuthenticationMode.md#gethttpsagent) +- [headers](api.ApiGetAuthenticationMode.md#headers) +- [parse](api.ApiGetAuthenticationMode.md#parse) +- [request](api.ApiGetAuthenticationMode.md#request) +- [url](api.ApiGetAuthenticationMode.md#url) + +## Constructors + +### constructor + +• **new ApiGetAuthenticationMode**(`config`): [`ApiGetAuthenticationMode`](api.ApiGetAuthenticationMode.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | + +#### Returns + +[`ApiGetAuthenticationMode`](api.ApiGetAuthenticationMode.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +api.ts:507 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`ApiGetAuthenticationModeResponse`](api.ApiGetAuthenticationModeResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`ApiGetAuthenticationModeResponse`](api.ApiGetAuthenticationModeResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +api.ts:513 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/api.ApiGetAuthenticationModeResponse.md b/docs/classes/api.ApiGetAuthenticationModeResponse.md new file mode 100644 index 0000000..cbd2a76 --- /dev/null +++ b/docs/classes/api.ApiGetAuthenticationModeResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiGetAuthenticationModeResponse + +# Class: ApiGetAuthenticationModeResponse + +[api](../modules/api.md).ApiGetAuthenticationModeResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`ApiGetAuthenticationModeResponse`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiGetAuthenticationModeResponse.md#constructor) + +### Properties + +- [error](api.ApiGetAuthenticationModeResponse.md#error) +- [id](api.ApiGetAuthenticationModeResponse.md#id) +- [kind](api.ApiGetAuthenticationModeResponse.md#kind) +- [result](api.ApiGetAuthenticationModeResponse.md#result) + +### Methods + +- [\_\_str\_\_](api.ApiGetAuthenticationModeResponse.md#__str__) +- [is\_error](api.ApiGetAuthenticationModeResponse.md#is_error) +- [parse](api.ApiGetAuthenticationModeResponse.md#parse) + +## Constructors + +### constructor + +• **new ApiGetAuthenticationModeResponse**(): [`ApiGetAuthenticationModeResponse`](api.ApiGetAuthenticationModeResponse.md) + +#### Returns + +[`ApiGetAuthenticationModeResponse`](api.ApiGetAuthenticationModeResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +api.ts:549 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `string`[] + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +api.ts:548 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/api.ApiGetCertificateUrl.md b/docs/classes/api.ApiGetCertificateUrl.md new file mode 100644 index 0000000..07f5958 --- /dev/null +++ b/docs/classes/api.ApiGetCertificateUrl.md @@ -0,0 +1,381 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiGetCertificateUrl + +# Class: ApiGetCertificateUrl + +[api](../modules/api.md).ApiGetCertificateUrl + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`ApiGetCertificateUrl`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiGetCertificateUrl.md#constructor) + +### Properties + +- [address](api.ApiGetCertificateUrl.md#address) +- [method](api.ApiGetCertificateUrl.md#method) +- [params](api.ApiGetCertificateUrl.md#params) +- [plcCertificate](api.ApiGetCertificateUrl.md#plccertificate) +- [protocol](api.ApiGetCertificateUrl.md#protocol) +- [response](api.ApiGetCertificateUrl.md#response) +- [token](api.ApiGetCertificateUrl.md#token) +- [verifyTls](api.ApiGetCertificateUrl.md#verifytls) + +### Methods + +- [\_\_str\_\_](api.ApiGetCertificateUrl.md#__str__) +- [body](api.ApiGetCertificateUrl.md#body) +- [execute](api.ApiGetCertificateUrl.md#execute) +- [format\_response](api.ApiGetCertificateUrl.md#format_response) +- [gethttpsAgent](api.ApiGetCertificateUrl.md#gethttpsagent) +- [headers](api.ApiGetCertificateUrl.md#headers) +- [parse](api.ApiGetCertificateUrl.md#parse) +- [request](api.ApiGetCertificateUrl.md#request) +- [url](api.ApiGetCertificateUrl.md#url) + +## Constructors + +### constructor + +• **new ApiGetCertificateUrl**(`config`): [`ApiGetCertificateUrl`](api.ApiGetCertificateUrl.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | + +#### Returns + +[`ApiGetCertificateUrl`](api.ApiGetCertificateUrl.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +api.ts:182 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`ApiGetCertificateUrlResponse`](api.ApiGetCertificateUrlResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`ApiGetCertificateUrlResponse`](api.ApiGetCertificateUrlResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +api.ts:187 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/api.ApiGetCertificateUrlResponse.md b/docs/classes/api.ApiGetCertificateUrlResponse.md new file mode 100644 index 0000000..5591dfe --- /dev/null +++ b/docs/classes/api.ApiGetCertificateUrlResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiGetCertificateUrlResponse + +# Class: ApiGetCertificateUrlResponse + +[api](../modules/api.md).ApiGetCertificateUrlResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`ApiGetCertificateUrlResponse`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiGetCertificateUrlResponse.md#constructor) + +### Properties + +- [error](api.ApiGetCertificateUrlResponse.md#error) +- [id](api.ApiGetCertificateUrlResponse.md#id) +- [kind](api.ApiGetCertificateUrlResponse.md#kind) +- [result](api.ApiGetCertificateUrlResponse.md#result) + +### Methods + +- [\_\_str\_\_](api.ApiGetCertificateUrlResponse.md#__str__) +- [is\_error](api.ApiGetCertificateUrlResponse.md#is_error) +- [parse](api.ApiGetCertificateUrlResponse.md#parse) + +## Constructors + +### constructor + +• **new ApiGetCertificateUrlResponse**(): [`ApiGetCertificateUrlResponse`](api.ApiGetCertificateUrlResponse.md) + +#### Returns + +[`ApiGetCertificateUrlResponse`](api.ApiGetCertificateUrlResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +api.ts:203 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `string` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +api.ts:202 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/api.ApiGetPasswordPolicy.md b/docs/classes/api.ApiGetPasswordPolicy.md new file mode 100644 index 0000000..625d15a --- /dev/null +++ b/docs/classes/api.ApiGetPasswordPolicy.md @@ -0,0 +1,381 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiGetPasswordPolicy + +# Class: ApiGetPasswordPolicy + +[api](../modules/api.md).ApiGetPasswordPolicy + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`ApiGetPasswordPolicy`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiGetPasswordPolicy.md#constructor) + +### Properties + +- [address](api.ApiGetPasswordPolicy.md#address) +- [method](api.ApiGetPasswordPolicy.md#method) +- [params](api.ApiGetPasswordPolicy.md#params) +- [plcCertificate](api.ApiGetPasswordPolicy.md#plccertificate) +- [protocol](api.ApiGetPasswordPolicy.md#protocol) +- [response](api.ApiGetPasswordPolicy.md#response) +- [token](api.ApiGetPasswordPolicy.md#token) +- [verifyTls](api.ApiGetPasswordPolicy.md#verifytls) + +### Methods + +- [\_\_str\_\_](api.ApiGetPasswordPolicy.md#__str__) +- [body](api.ApiGetPasswordPolicy.md#body) +- [execute](api.ApiGetPasswordPolicy.md#execute) +- [format\_response](api.ApiGetPasswordPolicy.md#format_response) +- [gethttpsAgent](api.ApiGetPasswordPolicy.md#gethttpsagent) +- [headers](api.ApiGetPasswordPolicy.md#headers) +- [parse](api.ApiGetPasswordPolicy.md#parse) +- [request](api.ApiGetPasswordPolicy.md#request) +- [url](api.ApiGetPasswordPolicy.md#url) + +## Constructors + +### constructor + +• **new ApiGetPasswordPolicy**(`config`): [`ApiGetPasswordPolicy`](api.ApiGetPasswordPolicy.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | + +#### Returns + +[`ApiGetPasswordPolicy`](api.ApiGetPasswordPolicy.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +api.ts:450 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`ApiGetPasswordPolicyResponse`](api.ApiGetPasswordPolicyResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`ApiGetPasswordPolicyResponse`](api.ApiGetPasswordPolicyResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +api.ts:456 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/api.ApiGetPasswordPolicyResponse.md b/docs/classes/api.ApiGetPasswordPolicyResponse.md new file mode 100644 index 0000000..2a0d04b --- /dev/null +++ b/docs/classes/api.ApiGetPasswordPolicyResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiGetPasswordPolicyResponse + +# Class: ApiGetPasswordPolicyResponse + +[api](../modules/api.md).ApiGetPasswordPolicyResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`ApiGetPasswordPolicyResponse`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiGetPasswordPolicyResponse.md#constructor) + +### Properties + +- [error](api.ApiGetPasswordPolicyResponse.md#error) +- [id](api.ApiGetPasswordPolicyResponse.md#id) +- [kind](api.ApiGetPasswordPolicyResponse.md#kind) +- [result](api.ApiGetPasswordPolicyResponse.md#result) + +### Methods + +- [\_\_str\_\_](api.ApiGetPasswordPolicyResponse.md#__str__) +- [is\_error](api.ApiGetPasswordPolicyResponse.md#is_error) +- [parse](api.ApiGetPasswordPolicyResponse.md#parse) + +## Constructors + +### constructor + +• **new ApiGetPasswordPolicyResponse**(): [`ApiGetPasswordPolicyResponse`](api.ApiGetPasswordPolicyResponse.md) + +#### Returns + +[`ApiGetPasswordPolicyResponse`](api.ApiGetPasswordPolicyResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +api.ts:502 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: [`PasswordPolicy`](api.PasswordPolicy.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +api.ts:501 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/api.ApiGetPermissions.md b/docs/classes/api.ApiGetPermissions.md new file mode 100644 index 0000000..fe865f0 --- /dev/null +++ b/docs/classes/api.ApiGetPermissions.md @@ -0,0 +1,381 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiGetPermissions + +# Class: ApiGetPermissions + +[api](../modules/api.md).ApiGetPermissions + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`ApiGetPermissions`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiGetPermissions.md#constructor) + +### Properties + +- [address](api.ApiGetPermissions.md#address) +- [method](api.ApiGetPermissions.md#method) +- [params](api.ApiGetPermissions.md#params) +- [plcCertificate](api.ApiGetPermissions.md#plccertificate) +- [protocol](api.ApiGetPermissions.md#protocol) +- [response](api.ApiGetPermissions.md#response) +- [token](api.ApiGetPermissions.md#token) +- [verifyTls](api.ApiGetPermissions.md#verifytls) + +### Methods + +- [\_\_str\_\_](api.ApiGetPermissions.md#__str__) +- [body](api.ApiGetPermissions.md#body) +- [execute](api.ApiGetPermissions.md#execute) +- [format\_response](api.ApiGetPermissions.md#format_response) +- [gethttpsAgent](api.ApiGetPermissions.md#gethttpsagent) +- [headers](api.ApiGetPermissions.md#headers) +- [parse](api.ApiGetPermissions.md#parse) +- [request](api.ApiGetPermissions.md#request) +- [url](api.ApiGetPermissions.md#url) + +## Constructors + +### constructor + +• **new ApiGetPermissions**(`config`): [`ApiGetPermissions`](api.ApiGetPermissions.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | + +#### Returns + +[`ApiGetPermissions`](api.ApiGetPermissions.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +api.ts:114 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`ApiGetPermissionsResponse`](api.ApiGetPermissionsResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`ApiGetPermissionsResponse`](api.ApiGetPermissionsResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +api.ts:120 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/api.ApiGetPermissionsResponse.md b/docs/classes/api.ApiGetPermissionsResponse.md new file mode 100644 index 0000000..706dd0d --- /dev/null +++ b/docs/classes/api.ApiGetPermissionsResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiGetPermissionsResponse + +# Class: ApiGetPermissionsResponse + +[api](../modules/api.md).ApiGetPermissionsResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`ApiGetPermissionsResponse`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiGetPermissionsResponse.md#constructor) + +### Properties + +- [error](api.ApiGetPermissionsResponse.md#error) +- [id](api.ApiGetPermissionsResponse.md#id) +- [kind](api.ApiGetPermissionsResponse.md#kind) +- [result](api.ApiGetPermissionsResponse.md#result) + +### Methods + +- [\_\_str\_\_](api.ApiGetPermissionsResponse.md#__str__) +- [is\_error](api.ApiGetPermissionsResponse.md#is_error) +- [parse](api.ApiGetPermissionsResponse.md#parse) + +## Constructors + +### constructor + +• **new ApiGetPermissionsResponse**(): [`ApiGetPermissionsResponse`](api.ApiGetPermissionsResponse.md) + +#### Returns + +[`ApiGetPermissionsResponse`](api.ApiGetPermissionsResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +api.ts:148 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `string`[] + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +api.ts:147 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/api.ApiGetQuantityStructures.md b/docs/classes/api.ApiGetQuantityStructures.md new file mode 100644 index 0000000..651e9da --- /dev/null +++ b/docs/classes/api.ApiGetQuantityStructures.md @@ -0,0 +1,382 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiGetQuantityStructures + +# Class: ApiGetQuantityStructures + +[api](../modules/api.md).ApiGetQuantityStructures + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`ApiGetQuantityStructures`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiGetQuantityStructures.md#constructor) + +### Properties + +- [address](api.ApiGetQuantityStructures.md#address) +- [method](api.ApiGetQuantityStructures.md#method) +- [params](api.ApiGetQuantityStructures.md#params) +- [plcCertificate](api.ApiGetQuantityStructures.md#plccertificate) +- [protocol](api.ApiGetQuantityStructures.md#protocol) +- [response](api.ApiGetQuantityStructures.md#response) +- [token](api.ApiGetQuantityStructures.md#token) +- [verifyTls](api.ApiGetQuantityStructures.md#verifytls) + +### Methods + +- [\_\_str\_\_](api.ApiGetQuantityStructures.md#__str__) +- [body](api.ApiGetQuantityStructures.md#body) +- [execute](api.ApiGetQuantityStructures.md#execute) +- [format\_response](api.ApiGetQuantityStructures.md#format_response) +- [gethttpsAgent](api.ApiGetQuantityStructures.md#gethttpsagent) +- [headers](api.ApiGetQuantityStructures.md#headers) +- [parse](api.ApiGetQuantityStructures.md#parse) +- [request](api.ApiGetQuantityStructures.md#request) +- [url](api.ApiGetQuantityStructures.md#url) + +## Constructors + +### constructor + +• **new ApiGetQuantityStructures**(`config`, `token`): [`ApiGetQuantityStructures`](api.ApiGetQuantityStructures.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | + +#### Returns + +[`ApiGetQuantityStructures`](api.ApiGetQuantityStructures.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +api.ts:354 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`ApiGetQuantityStructuresResponse`](api.ApiGetQuantityStructuresResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`ApiGetQuantityStructuresResponse`](api.ApiGetQuantityStructuresResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +api.ts:361 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/api.ApiGetQuantityStructuresResponse.md b/docs/classes/api.ApiGetQuantityStructuresResponse.md new file mode 100644 index 0000000..5f5b0e7 --- /dev/null +++ b/docs/classes/api.ApiGetQuantityStructuresResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiGetQuantityStructuresResponse + +# Class: ApiGetQuantityStructuresResponse + +[api](../modules/api.md).ApiGetQuantityStructuresResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`ApiGetQuantityStructuresResponse`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiGetQuantityStructuresResponse.md#constructor) + +### Properties + +- [error](api.ApiGetQuantityStructuresResponse.md#error) +- [id](api.ApiGetQuantityStructuresResponse.md#id) +- [kind](api.ApiGetQuantityStructuresResponse.md#kind) +- [result](api.ApiGetQuantityStructuresResponse.md#result) + +### Methods + +- [\_\_str\_\_](api.ApiGetQuantityStructuresResponse.md#__str__) +- [is\_error](api.ApiGetQuantityStructuresResponse.md#is_error) +- [parse](api.ApiGetQuantityStructuresResponse.md#parse) + +## Constructors + +### constructor + +• **new ApiGetQuantityStructuresResponse**(): [`ApiGetQuantityStructuresResponse`](api.ApiGetQuantityStructuresResponse.md) + +#### Returns + +[`ApiGetQuantityStructuresResponse`](api.ApiGetQuantityStructuresResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +api.ts:408 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: [`QuantityStructure`](api.QuantityStructure.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +api.ts:407 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/api.ApiLogin.md b/docs/classes/api.ApiLogin.md new file mode 100644 index 0000000..40ba45c --- /dev/null +++ b/docs/classes/api.ApiLogin.md @@ -0,0 +1,384 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiLogin + +# Class: ApiLogin + +[api](../modules/api.md).ApiLogin + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`ApiLogin`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiLogin.md#constructor) + +### Properties + +- [address](api.ApiLogin.md#address) +- [method](api.ApiLogin.md#method) +- [params](api.ApiLogin.md#params) +- [plcCertificate](api.ApiLogin.md#plccertificate) +- [protocol](api.ApiLogin.md#protocol) +- [response](api.ApiLogin.md#response) +- [token](api.ApiLogin.md#token) +- [verifyTls](api.ApiLogin.md#verifytls) + +### Methods + +- [\_\_str\_\_](api.ApiLogin.md#__str__) +- [body](api.ApiLogin.md#body) +- [execute](api.ApiLogin.md#execute) +- [format\_response](api.ApiLogin.md#format_response) +- [gethttpsAgent](api.ApiLogin.md#gethttpsagent) +- [headers](api.ApiLogin.md#headers) +- [parse](api.ApiLogin.md#parse) +- [request](api.ApiLogin.md#request) +- [url](api.ApiLogin.md#url) + +## Constructors + +### constructor + +• **new ApiLogin**(`config`, `user?`, `password?`, `include_web_application_cookie?`): [`ApiLogin`](api.ApiLogin.md) + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | `undefined` | +| `user` | `string` | `"Anonymous"` | +| `password` | `string` | `""` | +| `include_web_application_cookie?` | `boolean` | `undefined` | + +#### Returns + +[`ApiLogin`](api.ApiLogin.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +api.ts:17 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`ApiLoginResponse`](api.ApiLoginResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`ApiLoginResponse`](api.ApiLoginResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +api.ts:24 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/api.ApiLoginResponse.md b/docs/classes/api.ApiLoginResponse.md new file mode 100644 index 0000000..8f15cf4 --- /dev/null +++ b/docs/classes/api.ApiLoginResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiLoginResponse + +# Class: ApiLoginResponse + +[api](../modules/api.md).ApiLoginResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`ApiLoginResponse`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiLoginResponse.md#constructor) + +### Properties + +- [error](api.ApiLoginResponse.md#error) +- [id](api.ApiLoginResponse.md#id) +- [kind](api.ApiLoginResponse.md#kind) +- [result](api.ApiLoginResponse.md#result) + +### Methods + +- [\_\_str\_\_](api.ApiLoginResponse.md#__str__) +- [is\_error](api.ApiLoginResponse.md#is_error) +- [parse](api.ApiLoginResponse.md#parse) + +## Constructors + +### constructor + +• **new ApiLoginResponse**(): [`ApiLoginResponse`](api.ApiLoginResponse.md) + +#### Returns + +[`ApiLoginResponse`](api.ApiLoginResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +api.ts:42 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `string` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +api.ts:41 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/api.ApiLogout.md b/docs/classes/api.ApiLogout.md new file mode 100644 index 0000000..20d5254 --- /dev/null +++ b/docs/classes/api.ApiLogout.md @@ -0,0 +1,382 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiLogout + +# Class: ApiLogout + +[api](../modules/api.md).ApiLogout + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`ApiLogout`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiLogout.md#constructor) + +### Properties + +- [address](api.ApiLogout.md#address) +- [method](api.ApiLogout.md#method) +- [params](api.ApiLogout.md#params) +- [plcCertificate](api.ApiLogout.md#plccertificate) +- [protocol](api.ApiLogout.md#protocol) +- [response](api.ApiLogout.md#response) +- [token](api.ApiLogout.md#token) +- [verifyTls](api.ApiLogout.md#verifytls) + +### Methods + +- [\_\_str\_\_](api.ApiLogout.md#__str__) +- [body](api.ApiLogout.md#body) +- [execute](api.ApiLogout.md#execute) +- [format\_response](api.ApiLogout.md#format_response) +- [gethttpsAgent](api.ApiLogout.md#gethttpsagent) +- [headers](api.ApiLogout.md#headers) +- [parse](api.ApiLogout.md#parse) +- [request](api.ApiLogout.md#request) +- [url](api.ApiLogout.md#url) + +## Constructors + +### constructor + +• **new ApiLogout**(`config`, `token`): [`ApiLogout`](api.ApiLogout.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | + +#### Returns + +[`ApiLogout`](api.ApiLogout.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +api.ts:154 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`ApiLogoutResponse`](api.ApiLogoutResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`ApiLogoutResponse`](api.ApiLogoutResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +api.ts:160 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/api.ApiLogoutResponse.md b/docs/classes/api.ApiLogoutResponse.md new file mode 100644 index 0000000..7634601 --- /dev/null +++ b/docs/classes/api.ApiLogoutResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiLogoutResponse + +# Class: ApiLogoutResponse + +[api](../modules/api.md).ApiLogoutResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`ApiLogoutResponse`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiLogoutResponse.md#constructor) + +### Properties + +- [error](api.ApiLogoutResponse.md#error) +- [id](api.ApiLogoutResponse.md#id) +- [kind](api.ApiLogoutResponse.md#kind) +- [result](api.ApiLogoutResponse.md#result) + +### Methods + +- [\_\_str\_\_](api.ApiLogoutResponse.md#__str__) +- [is\_error](api.ApiLogoutResponse.md#is_error) +- [parse](api.ApiLogoutResponse.md#parse) + +## Constructors + +### constructor + +• **new ApiLogoutResponse**(): [`ApiLogoutResponse`](api.ApiLogoutResponse.md) + +#### Returns + +[`ApiLogoutResponse`](api.ApiLogoutResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +api.ts:176 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +api.ts:175 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/api.ApiPing.md b/docs/classes/api.ApiPing.md new file mode 100644 index 0000000..da70718 --- /dev/null +++ b/docs/classes/api.ApiPing.md @@ -0,0 +1,381 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiPing + +# Class: ApiPing + +[api](../modules/api.md).ApiPing + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`ApiPing`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiPing.md#constructor) + +### Properties + +- [address](api.ApiPing.md#address) +- [method](api.ApiPing.md#method) +- [params](api.ApiPing.md#params) +- [plcCertificate](api.ApiPing.md#plccertificate) +- [protocol](api.ApiPing.md#protocol) +- [response](api.ApiPing.md#response) +- [token](api.ApiPing.md#token) +- [verifyTls](api.ApiPing.md#verifytls) + +### Methods + +- [\_\_str\_\_](api.ApiPing.md#__str__) +- [body](api.ApiPing.md#body) +- [execute](api.ApiPing.md#execute) +- [format\_response](api.ApiPing.md#format_response) +- [gethttpsAgent](api.ApiPing.md#gethttpsagent) +- [headers](api.ApiPing.md#headers) +- [parse](api.ApiPing.md#parse) +- [request](api.ApiPing.md#request) +- [url](api.ApiPing.md#url) + +## Constructors + +### constructor + +• **new ApiPing**(`config`): [`ApiPing`](api.ApiPing.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | + +#### Returns + +[`ApiPing`](api.ApiPing.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +api.ts:47 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`ApiPingResponse`](api.ApiPingResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`ApiPingResponse`](api.ApiPingResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +api.ts:53 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/api.ApiPingResponse.md b/docs/classes/api.ApiPingResponse.md new file mode 100644 index 0000000..0c7f3ca --- /dev/null +++ b/docs/classes/api.ApiPingResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiPingResponse + +# Class: ApiPingResponse + +[api](../modules/api.md).ApiPingResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`ApiPingResponse`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiPingResponse.md#constructor) + +### Properties + +- [error](api.ApiPingResponse.md#error) +- [id](api.ApiPingResponse.md#id) +- [kind](api.ApiPingResponse.md#kind) +- [result](api.ApiPingResponse.md#result) + +### Methods + +- [\_\_str\_\_](api.ApiPingResponse.md#__str__) +- [is\_error](api.ApiPingResponse.md#is_error) +- [parse](api.ApiPingResponse.md#parse) + +## Constructors + +### constructor + +• **new ApiPingResponse**(): [`ApiPingResponse`](api.ApiPingResponse.md) + +#### Returns + +[`ApiPingResponse`](api.ApiPingResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +api.ts:69 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `string` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +api.ts:68 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/api.ApiTicket.md b/docs/classes/api.ApiTicket.md new file mode 100644 index 0000000..aefc30e --- /dev/null +++ b/docs/classes/api.ApiTicket.md @@ -0,0 +1,79 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiTicket + +# Class: ApiTicket + +[api](../modules/api.md).ApiTicket + +## Table of contents + +### Constructors + +- [constructor](api.ApiTicket.md#constructor) + +### Properties + +- [data](api.ApiTicket.md#data) +- [date\_created](api.ApiTicket.md#date_created) +- [id](api.ApiTicket.md#id) +- [provider](api.ApiTicket.md#provider) +- [state](api.ApiTicket.md#state) + +## Constructors + +### constructor + +• **new ApiTicket**(): [`ApiTicket`](api.ApiTicket.md) + +#### Returns + +[`ApiTicket`](api.ApiTicket.md) + +## Properties + +### data + +• `Optional` **data**: `object` + +#### Defined in + +api.ts:268 + +___ + +### date\_created + +• **date\_created**: `string` = `""` + +#### Defined in + +api.ts:265 + +___ + +### id + +• **id**: `string` = `""` + +#### Defined in + +api.ts:264 + +___ + +### provider + +• **provider**: `string` = `""` + +#### Defined in + +api.ts:266 + +___ + +### state + +• **state**: [`ApiTicketState`](../enums/api.ApiTicketState.md) = `ApiTicketState.FAILED` + +#### Defined in + +api.ts:267 diff --git a/docs/classes/api.ApiVersion.md b/docs/classes/api.ApiVersion.md new file mode 100644 index 0000000..60e6fb3 --- /dev/null +++ b/docs/classes/api.ApiVersion.md @@ -0,0 +1,381 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiVersion + +# Class: ApiVersion + +[api](../modules/api.md).ApiVersion + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`ApiVersion`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiVersion.md#constructor) + +### Properties + +- [address](api.ApiVersion.md#address) +- [method](api.ApiVersion.md#method) +- [params](api.ApiVersion.md#params) +- [plcCertificate](api.ApiVersion.md#plccertificate) +- [protocol](api.ApiVersion.md#protocol) +- [response](api.ApiVersion.md#response) +- [token](api.ApiVersion.md#token) +- [verifyTls](api.ApiVersion.md#verifytls) + +### Methods + +- [\_\_str\_\_](api.ApiVersion.md#__str__) +- [body](api.ApiVersion.md#body) +- [execute](api.ApiVersion.md#execute) +- [format\_response](api.ApiVersion.md#format_response) +- [gethttpsAgent](api.ApiVersion.md#gethttpsagent) +- [headers](api.ApiVersion.md#headers) +- [parse](api.ApiVersion.md#parse) +- [request](api.ApiVersion.md#request) +- [url](api.ApiVersion.md#url) + +## Constructors + +### constructor + +• **new ApiVersion**(`config`): [`ApiVersion`](api.ApiVersion.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | + +#### Returns + +[`ApiVersion`](api.ApiVersion.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +api.ts:208 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`ApiVersionResponse`](api.ApiVersionResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`ApiVersionResponse`](api.ApiVersionResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +api.ts:213 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/api.ApiVersionResponse.md b/docs/classes/api.ApiVersionResponse.md new file mode 100644 index 0000000..aa2bbef --- /dev/null +++ b/docs/classes/api.ApiVersionResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiVersionResponse + +# Class: ApiVersionResponse + +[api](../modules/api.md).ApiVersionResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`ApiVersionResponse`** + +## Table of contents + +### Constructors + +- [constructor](api.ApiVersionResponse.md#constructor) + +### Properties + +- [error](api.ApiVersionResponse.md#error) +- [id](api.ApiVersionResponse.md#id) +- [kind](api.ApiVersionResponse.md#kind) +- [result](api.ApiVersionResponse.md#result) + +### Methods + +- [\_\_str\_\_](api.ApiVersionResponse.md#__str__) +- [is\_error](api.ApiVersionResponse.md#is_error) +- [parse](api.ApiVersionResponse.md#parse) + +## Constructors + +### constructor + +• **new ApiVersionResponse**(): [`ApiVersionResponse`](api.ApiVersionResponse.md) + +#### Returns + +[`ApiVersionResponse`](api.ApiVersionResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +api.ts:231 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `number` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +api.ts:230 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/api.CustomTicket.md b/docs/classes/api.CustomTicket.md new file mode 100644 index 0000000..f83818a --- /dev/null +++ b/docs/classes/api.CustomTicket.md @@ -0,0 +1,46 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / CustomTicket + +# Class: CustomTicket + +[api](../modules/api.md).CustomTicket + +## Table of contents + +### Constructors + +- [constructor](api.CustomTicket.md#constructor) + +### Properties + +- [max\_tickets](api.CustomTicket.md#max_tickets) +- [ticket](api.CustomTicket.md#ticket) + +## Constructors + +### constructor + +• **new CustomTicket**(): [`CustomTicket`](api.CustomTicket.md) + +#### Returns + +[`CustomTicket`](api.CustomTicket.md) + +## Properties + +### max\_tickets + +• **max\_tickets**: `Number` = `0` + +#### Defined in + +api.ts:272 + +___ + +### ticket + +• **ticket**: [`ApiTicket`](api.ApiTicket.md)[] = `[]` + +#### Defined in + +api.ts:273 diff --git a/docs/classes/api.PasswordPolicy.md b/docs/classes/api.PasswordPolicy.md new file mode 100644 index 0000000..aeaeca7 --- /dev/null +++ b/docs/classes/api.PasswordPolicy.md @@ -0,0 +1,90 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / PasswordPolicy + +# Class: PasswordPolicy + +[api](../modules/api.md).PasswordPolicy + +## Table of contents + +### Constructors + +- [constructor](api.PasswordPolicy.md#constructor) + +### Properties + +- [max\_password\_length](api.PasswordPolicy.md#max_password_length) +- [min\_digits](api.PasswordPolicy.md#min_digits) +- [min\_password\_length](api.PasswordPolicy.md#min_password_length) +- [min\_special\_characters](api.PasswordPolicy.md#min_special_characters) +- [requires\_lowercase\_characters](api.PasswordPolicy.md#requires_lowercase_characters) +- [requires\_uppercase\_characters](api.PasswordPolicy.md#requires_uppercase_characters) + +## Constructors + +### constructor + +• **new PasswordPolicy**(): [`PasswordPolicy`](api.PasswordPolicy.md) + +#### Returns + +[`PasswordPolicy`](api.PasswordPolicy.md) + +## Properties + +### max\_password\_length + +• **max\_password\_length**: `Number` = `0` + +#### Defined in + +api.ts:443 + +___ + +### min\_digits + +• **min\_digits**: `Number` = `0` + +#### Defined in + +api.ts:444 + +___ + +### min\_password\_length + +• **min\_password\_length**: `Number` = `0` + +#### Defined in + +api.ts:442 + +___ + +### min\_special\_characters + +• **min\_special\_characters**: `Number` = `0` + +#### Defined in + +api.ts:445 + +___ + +### requires\_lowercase\_characters + +• **requires\_lowercase\_characters**: `boolean` = `false` + +#### Defined in + +api.ts:447 + +___ + +### requires\_uppercase\_characters + +• **requires\_uppercase\_characters**: `boolean` = `false` + +#### Defined in + +api.ts:446 diff --git a/docs/classes/api.QuantityStructure.md b/docs/classes/api.QuantityStructure.md new file mode 100644 index 0000000..220d6c4 --- /dev/null +++ b/docs/classes/api.QuantityStructure.md @@ -0,0 +1,57 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / QuantityStructure + +# Class: QuantityStructure + +[api](../modules/api.md).QuantityStructure + +## Table of contents + +### Constructors + +- [constructor](api.QuantityStructure.md#constructor) + +### Properties + +- [webapi\_max\_http\_request\_body\_size](api.QuantityStructure.md#webapi_max_http_request_body_size) +- [webapi\_max\_parallel\_requests](api.QuantityStructure.md#webapi_max_parallel_requests) +- [webapi\_max\_parallel\_user\_sessions](api.QuantityStructure.md#webapi_max_parallel_user_sessions) + +## Constructors + +### constructor + +• **new QuantityStructure**(): [`QuantityStructure`](api.QuantityStructure.md) + +#### Returns + +[`QuantityStructure`](api.QuantityStructure.md) + +## Properties + +### webapi\_max\_http\_request\_body\_size + +• **webapi\_max\_http\_request\_body\_size**: `Number` = `0` + +#### Defined in + +api.ts:348 + +___ + +### webapi\_max\_parallel\_requests + +• **webapi\_max\_parallel\_requests**: `Number` = `0` + +#### Defined in + +api.ts:349 + +___ + +### webapi\_max\_parallel\_user\_sessions + +• **webapi\_max\_parallel\_user\_sessions**: `Number` = `0` + +#### Defined in + +api.ts:350 diff --git a/docs/classes/datalogs.DataLogsDownloadAndClear.md b/docs/classes/datalogs.DataLogsDownloadAndClear.md new file mode 100644 index 0000000..642e6ae --- /dev/null +++ b/docs/classes/datalogs.DataLogsDownloadAndClear.md @@ -0,0 +1,383 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [datalogs](../modules/datalogs.md) / DataLogsDownloadAndClear + +# Class: DataLogsDownloadAndClear + +[datalogs](../modules/datalogs.md).DataLogsDownloadAndClear + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`DataLogsDownloadAndClear`** + +## Table of contents + +### Constructors + +- [constructor](datalogs.DataLogsDownloadAndClear.md#constructor) + +### Properties + +- [address](datalogs.DataLogsDownloadAndClear.md#address) +- [method](datalogs.DataLogsDownloadAndClear.md#method) +- [params](datalogs.DataLogsDownloadAndClear.md#params) +- [plcCertificate](datalogs.DataLogsDownloadAndClear.md#plccertificate) +- [protocol](datalogs.DataLogsDownloadAndClear.md#protocol) +- [response](datalogs.DataLogsDownloadAndClear.md#response) +- [token](datalogs.DataLogsDownloadAndClear.md#token) +- [verifyTls](datalogs.DataLogsDownloadAndClear.md#verifytls) + +### Methods + +- [\_\_str\_\_](datalogs.DataLogsDownloadAndClear.md#__str__) +- [body](datalogs.DataLogsDownloadAndClear.md#body) +- [execute](datalogs.DataLogsDownloadAndClear.md#execute) +- [format\_response](datalogs.DataLogsDownloadAndClear.md#format_response) +- [gethttpsAgent](datalogs.DataLogsDownloadAndClear.md#gethttpsagent) +- [headers](datalogs.DataLogsDownloadAndClear.md#headers) +- [parse](datalogs.DataLogsDownloadAndClear.md#parse) +- [request](datalogs.DataLogsDownloadAndClear.md#request) +- [url](datalogs.DataLogsDownloadAndClear.md#url) + +## Constructors + +### constructor + +• **new DataLogsDownloadAndClear**(`config`, `token`, `resource`): [`DataLogsDownloadAndClear`](datalogs.DataLogsDownloadAndClear.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `resource` | `string` | + +#### Returns + +[`DataLogsDownloadAndClear`](datalogs.DataLogsDownloadAndClear.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +datalogs.ts:6 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`DataLogsDownloadAndClearResponse`](datalogs.DataLogsDownloadAndClearResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`DataLogsDownloadAndClearResponse`](datalogs.DataLogsDownloadAndClearResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +datalogs.ts:12 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/datalogs.DataLogsDownloadAndClearResponse.md b/docs/classes/datalogs.DataLogsDownloadAndClearResponse.md new file mode 100644 index 0000000..fdc8ff7 --- /dev/null +++ b/docs/classes/datalogs.DataLogsDownloadAndClearResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [datalogs](../modules/datalogs.md) / DataLogsDownloadAndClearResponse + +# Class: DataLogsDownloadAndClearResponse + +[datalogs](../modules/datalogs.md).DataLogsDownloadAndClearResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`DataLogsDownloadAndClearResponse`** + +## Table of contents + +### Constructors + +- [constructor](datalogs.DataLogsDownloadAndClearResponse.md#constructor) + +### Properties + +- [error](datalogs.DataLogsDownloadAndClearResponse.md#error) +- [id](datalogs.DataLogsDownloadAndClearResponse.md#id) +- [kind](datalogs.DataLogsDownloadAndClearResponse.md#kind) +- [result](datalogs.DataLogsDownloadAndClearResponse.md#result) + +### Methods + +- [\_\_str\_\_](datalogs.DataLogsDownloadAndClearResponse.md#__str__) +- [is\_error](datalogs.DataLogsDownloadAndClearResponse.md#is_error) +- [parse](datalogs.DataLogsDownloadAndClearResponse.md#parse) + +## Constructors + +### constructor + +• **new DataLogsDownloadAndClearResponse**(): [`DataLogsDownloadAndClearResponse`](datalogs.DataLogsDownloadAndClearResponse.md) + +#### Returns + +[`DataLogsDownloadAndClearResponse`](datalogs.DataLogsDownloadAndClearResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +datalogs.ts:31 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `string` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +datalogs.ts:30 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/diagnosticbuffer.DiagnosticBufferBrowse.md b/docs/classes/diagnosticbuffer.DiagnosticBufferBrowse.md new file mode 100644 index 0000000..159bc29 --- /dev/null +++ b/docs/classes/diagnosticbuffer.DiagnosticBufferBrowse.md @@ -0,0 +1,385 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [diagnosticbuffer](../modules/diagnosticbuffer.md) / DiagnosticBufferBrowse + +# Class: DiagnosticBufferBrowse + +[diagnosticbuffer](../modules/diagnosticbuffer.md).DiagnosticBufferBrowse + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`DiagnosticBufferBrowse`** + +## Table of contents + +### Constructors + +- [constructor](diagnosticbuffer.DiagnosticBufferBrowse.md#constructor) + +### Properties + +- [address](diagnosticbuffer.DiagnosticBufferBrowse.md#address) +- [method](diagnosticbuffer.DiagnosticBufferBrowse.md#method) +- [params](diagnosticbuffer.DiagnosticBufferBrowse.md#params) +- [plcCertificate](diagnosticbuffer.DiagnosticBufferBrowse.md#plccertificate) +- [protocol](diagnosticbuffer.DiagnosticBufferBrowse.md#protocol) +- [response](diagnosticbuffer.DiagnosticBufferBrowse.md#response) +- [token](diagnosticbuffer.DiagnosticBufferBrowse.md#token) +- [verifyTls](diagnosticbuffer.DiagnosticBufferBrowse.md#verifytls) + +### Methods + +- [\_\_str\_\_](diagnosticbuffer.DiagnosticBufferBrowse.md#__str__) +- [body](diagnosticbuffer.DiagnosticBufferBrowse.md#body) +- [execute](diagnosticbuffer.DiagnosticBufferBrowse.md#execute) +- [format\_response](diagnosticbuffer.DiagnosticBufferBrowse.md#format_response) +- [gethttpsAgent](diagnosticbuffer.DiagnosticBufferBrowse.md#gethttpsagent) +- [headers](diagnosticbuffer.DiagnosticBufferBrowse.md#headers) +- [parse](diagnosticbuffer.DiagnosticBufferBrowse.md#parse) +- [request](diagnosticbuffer.DiagnosticBufferBrowse.md#request) +- [url](diagnosticbuffer.DiagnosticBufferBrowse.md#url) + +## Constructors + +### constructor + +• **new DiagnosticBufferBrowse**(`config`, `token`, `language`, `count?`, `filters?`): [`DiagnosticBufferBrowse`](diagnosticbuffer.DiagnosticBufferBrowse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `language` | `string` | +| `count?` | `number` | +| `filters?` | [`Filters`](diagnosticbuffer.Filters.md) | + +#### Returns + +[`DiagnosticBufferBrowse`](diagnosticbuffer.DiagnosticBufferBrowse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +diagnosticbuffer.ts:32 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`DiagnosticBufferBrowseResponse`](diagnosticbuffer.DiagnosticBufferBrowseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`DiagnosticBufferBrowseResponse`](diagnosticbuffer.DiagnosticBufferBrowseResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +diagnosticbuffer.ts:46 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/diagnosticbuffer.DiagnosticBufferBrowseResponse.md b/docs/classes/diagnosticbuffer.DiagnosticBufferBrowseResponse.md new file mode 100644 index 0000000..f3c6784 --- /dev/null +++ b/docs/classes/diagnosticbuffer.DiagnosticBufferBrowseResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [diagnosticbuffer](../modules/diagnosticbuffer.md) / DiagnosticBufferBrowseResponse + +# Class: DiagnosticBufferBrowseResponse + +[diagnosticbuffer](../modules/diagnosticbuffer.md).DiagnosticBufferBrowseResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`DiagnosticBufferBrowseResponse`** + +## Table of contents + +### Constructors + +- [constructor](diagnosticbuffer.DiagnosticBufferBrowseResponse.md#constructor) + +### Properties + +- [error](diagnosticbuffer.DiagnosticBufferBrowseResponse.md#error) +- [id](diagnosticbuffer.DiagnosticBufferBrowseResponse.md#id) +- [kind](diagnosticbuffer.DiagnosticBufferBrowseResponse.md#kind) +- [result](diagnosticbuffer.DiagnosticBufferBrowseResponse.md#result) + +### Methods + +- [\_\_str\_\_](diagnosticbuffer.DiagnosticBufferBrowseResponse.md#__str__) +- [is\_error](diagnosticbuffer.DiagnosticBufferBrowseResponse.md#is_error) +- [parse](diagnosticbuffer.DiagnosticBufferBrowseResponse.md#parse) + +## Constructors + +### constructor + +• **new DiagnosticBufferBrowseResponse**(): [`DiagnosticBufferBrowseResponse`](diagnosticbuffer.DiagnosticBufferBrowseResponse.md) + +#### Returns + +[`DiagnosticBufferBrowseResponse`](diagnosticbuffer.DiagnosticBufferBrowseResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +diagnosticbuffer.ts:119 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: [`DiagnosticBufferStructure`](diagnosticbuffer.DiagnosticBufferStructure.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +diagnosticbuffer.ts:118 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/diagnosticbuffer.DiagnosticBufferStructure.md b/docs/classes/diagnosticbuffer.DiagnosticBufferStructure.md new file mode 100644 index 0000000..330bfb0 --- /dev/null +++ b/docs/classes/diagnosticbuffer.DiagnosticBufferStructure.md @@ -0,0 +1,79 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [diagnosticbuffer](../modules/diagnosticbuffer.md) / DiagnosticBufferStructure + +# Class: DiagnosticBufferStructure + +[diagnosticbuffer](../modules/diagnosticbuffer.md).DiagnosticBufferStructure + +## Table of contents + +### Constructors + +- [constructor](diagnosticbuffer.DiagnosticBufferStructure.md#constructor) + +### Properties + +- [count\_current](diagnosticbuffer.DiagnosticBufferStructure.md#count_current) +- [count\_max](diagnosticbuffer.DiagnosticBufferStructure.md#count_max) +- [entries](diagnosticbuffer.DiagnosticBufferStructure.md#entries) +- [language](diagnosticbuffer.DiagnosticBufferStructure.md#language) +- [last\_modified](diagnosticbuffer.DiagnosticBufferStructure.md#last_modified) + +## Constructors + +### constructor + +• **new DiagnosticBufferStructure**(): [`DiagnosticBufferStructure`](diagnosticbuffer.DiagnosticBufferStructure.md) + +#### Returns + +[`DiagnosticBufferStructure`](diagnosticbuffer.DiagnosticBufferStructure.md) + +## Properties + +### count\_current + +• **count\_current**: `number` = `0` + +#### Defined in + +diagnosticbuffer.ts:26 + +___ + +### count\_max + +• **count\_max**: `number` = `0` + +#### Defined in + +diagnosticbuffer.ts:27 + +___ + +### entries + +• `Optional` **entries**: [`Entry`](diagnosticbuffer.Entry.md)[] + +#### Defined in + +diagnosticbuffer.ts:29 + +___ + +### language + +• `Optional` **language**: `string` + +#### Defined in + +diagnosticbuffer.ts:28 + +___ + +### last\_modified + +• **last\_modified**: `string` = `''` + +#### Defined in + +diagnosticbuffer.ts:25 diff --git a/docs/classes/diagnosticbuffer.Entry.md b/docs/classes/diagnosticbuffer.Entry.md new file mode 100644 index 0000000..dd0f334 --- /dev/null +++ b/docs/classes/diagnosticbuffer.Entry.md @@ -0,0 +1,90 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [diagnosticbuffer](../modules/diagnosticbuffer.md) / Entry + +# Class: Entry + +[diagnosticbuffer](../modules/diagnosticbuffer.md).Entry + +## Table of contents + +### Constructors + +- [constructor](diagnosticbuffer.Entry.md#constructor) + +### Properties + +- [event](diagnosticbuffer.Entry.md#event) +- [help\_text](diagnosticbuffer.Entry.md#help_text) +- [long\_text](diagnosticbuffer.Entry.md#long_text) +- [short\_text](diagnosticbuffer.Entry.md#short_text) +- [status](diagnosticbuffer.Entry.md#status) +- [timestamp](diagnosticbuffer.Entry.md#timestamp) + +## Constructors + +### constructor + +• **new Entry**(): [`Entry`](diagnosticbuffer.Entry.md) + +#### Returns + +[`Entry`](diagnosticbuffer.Entry.md) + +## Properties + +### event + +• **event**: [`Event`](diagnosticbuffer.Event.md) + +#### Defined in + +diagnosticbuffer.ts:21 + +___ + +### help\_text + +• **help\_text**: `string` = `''` + +#### Defined in + +diagnosticbuffer.ts:20 + +___ + +### long\_text + +• **long\_text**: `string` = `''` + +#### Defined in + +diagnosticbuffer.ts:18 + +___ + +### short\_text + +• **short\_text**: `string` = `''` + +#### Defined in + +diagnosticbuffer.ts:19 + +___ + +### status + +• **status**: `string` = `''` + +#### Defined in + +diagnosticbuffer.ts:17 + +___ + +### timestamp + +• **timestamp**: `string` = `''` + +#### Defined in + +diagnosticbuffer.ts:16 diff --git a/docs/classes/diagnosticbuffer.Event.md b/docs/classes/diagnosticbuffer.Event.md new file mode 100644 index 0000000..a4e0913 --- /dev/null +++ b/docs/classes/diagnosticbuffer.Event.md @@ -0,0 +1,46 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [diagnosticbuffer](../modules/diagnosticbuffer.md) / Event + +# Class: Event + +[diagnosticbuffer](../modules/diagnosticbuffer.md).Event + +## Table of contents + +### Constructors + +- [constructor](diagnosticbuffer.Event.md#constructor) + +### Properties + +- [text\_id](diagnosticbuffer.Event.md#text_id) +- [textlist\_id](diagnosticbuffer.Event.md#textlist_id) + +## Constructors + +### constructor + +• **new Event**(): [`Event`](diagnosticbuffer.Event.md) + +#### Returns + +[`Event`](diagnosticbuffer.Event.md) + +## Properties + +### text\_id + +• **text\_id**: `number` = `0` + +#### Defined in + +diagnosticbuffer.ts:12 + +___ + +### textlist\_id + +• **textlist\_id**: `number` = `0` + +#### Defined in + +diagnosticbuffer.ts:11 diff --git a/docs/classes/diagnosticbuffer.Filters.md b/docs/classes/diagnosticbuffer.Filters.md new file mode 100644 index 0000000..384c382 --- /dev/null +++ b/docs/classes/diagnosticbuffer.Filters.md @@ -0,0 +1,46 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [diagnosticbuffer](../modules/diagnosticbuffer.md) / Filters + +# Class: Filters + +[diagnosticbuffer](../modules/diagnosticbuffer.md).Filters + +## Table of contents + +### Constructors + +- [constructor](diagnosticbuffer.Filters.md#constructor) + +### Properties + +- [attributes](diagnosticbuffer.Filters.md#attributes) +- [mode](diagnosticbuffer.Filters.md#mode) + +## Constructors + +### constructor + +• **new Filters**(): [`Filters`](diagnosticbuffer.Filters.md) + +#### Returns + +[`Filters`](diagnosticbuffer.Filters.md) + +## Properties + +### attributes + +• **attributes**: `string`[] = `[]` + +#### Defined in + +diagnosticbuffer.ts:8 + +___ + +### mode + +• **mode**: `string` = `""` + +#### Defined in + +diagnosticbuffer.ts:7 diff --git a/docs/classes/failsafe.CPUResponse.md b/docs/classes/failsafe.CPUResponse.md new file mode 100644 index 0000000..1ccb966 --- /dev/null +++ b/docs/classes/failsafe.CPUResponse.md @@ -0,0 +1,57 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [failsafe](../modules/failsafe.md) / CPUResponse + +# Class: CPUResponse + +[failsafe](../modules/failsafe.md).CPUResponse + +## Table of contents + +### Constructors + +- [constructor](failsafe.CPUResponse.md#constructor) + +### Properties + +- [collective\_signature](failsafe.CPUResponse.md#collective_signature) +- [last\_f\_program\_modification](failsafe.CPUResponse.md#last_f_program_modification) +- [remaining\_time](failsafe.CPUResponse.md#remaining_time) + +## Constructors + +### constructor + +• **new CPUResponse**(): [`CPUResponse`](failsafe.CPUResponse.md) + +#### Returns + +[`CPUResponse`](failsafe.CPUResponse.md) + +## Properties + +### collective\_signature + +• **collective\_signature**: `string` = `''` + +#### Defined in + +failsafe.ts:72 + +___ + +### last\_f\_program\_modification + +• **last\_f\_program\_modification**: `string` = `''` + +#### Defined in + +failsafe.ts:71 + +___ + +### remaining\_time + +• `Optional` **remaining\_time**: `string` + +#### Defined in + +failsafe.ts:73 diff --git a/docs/classes/failsafe.FailsafeReadParameters.md b/docs/classes/failsafe.FailsafeReadParameters.md new file mode 100644 index 0000000..a9c07f9 --- /dev/null +++ b/docs/classes/failsafe.FailsafeReadParameters.md @@ -0,0 +1,383 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [failsafe](../modules/failsafe.md) / FailsafeReadParameters + +# Class: FailsafeReadParameters + +[failsafe](../modules/failsafe.md).FailsafeReadParameters + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`FailsafeReadParameters`** + +## Table of contents + +### Constructors + +- [constructor](failsafe.FailsafeReadParameters.md#constructor) + +### Properties + +- [address](failsafe.FailsafeReadParameters.md#address) +- [method](failsafe.FailsafeReadParameters.md#method) +- [params](failsafe.FailsafeReadParameters.md#params) +- [plcCertificate](failsafe.FailsafeReadParameters.md#plccertificate) +- [protocol](failsafe.FailsafeReadParameters.md#protocol) +- [response](failsafe.FailsafeReadParameters.md#response) +- [token](failsafe.FailsafeReadParameters.md#token) +- [verifyTls](failsafe.FailsafeReadParameters.md#verifytls) + +### Methods + +- [\_\_str\_\_](failsafe.FailsafeReadParameters.md#__str__) +- [body](failsafe.FailsafeReadParameters.md#body) +- [execute](failsafe.FailsafeReadParameters.md#execute) +- [format\_response](failsafe.FailsafeReadParameters.md#format_response) +- [gethttpsAgent](failsafe.FailsafeReadParameters.md#gethttpsagent) +- [headers](failsafe.FailsafeReadParameters.md#headers) +- [parse](failsafe.FailsafeReadParameters.md#parse) +- [request](failsafe.FailsafeReadParameters.md#request) +- [url](failsafe.FailsafeReadParameters.md#url) + +## Constructors + +### constructor + +• **new FailsafeReadParameters**(`config`, `token`, `hwid`): [`FailsafeReadParameters`](failsafe.FailsafeReadParameters.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `hwid` | `number` | + +#### Returns + +[`FailsafeReadParameters`](failsafe.FailsafeReadParameters.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +failsafe.ts:88 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`FailsafeReadParametersResponse`](failsafe.FailsafeReadParametersResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`FailsafeReadParametersResponse`](failsafe.FailsafeReadParametersResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +failsafe.ts:94 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/failsafe.FailsafeReadParametersResponse.md b/docs/classes/failsafe.FailsafeReadParametersResponse.md new file mode 100644 index 0000000..99c429c --- /dev/null +++ b/docs/classes/failsafe.FailsafeReadParametersResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [failsafe](../modules/failsafe.md) / FailsafeReadParametersResponse + +# Class: FailsafeReadParametersResponse + +[failsafe](../modules/failsafe.md).FailsafeReadParametersResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`FailsafeReadParametersResponse`** + +## Table of contents + +### Constructors + +- [constructor](failsafe.FailsafeReadParametersResponse.md#constructor) + +### Properties + +- [error](failsafe.FailsafeReadParametersResponse.md#error) +- [id](failsafe.FailsafeReadParametersResponse.md#id) +- [kind](failsafe.FailsafeReadParametersResponse.md#kind) +- [result](failsafe.FailsafeReadParametersResponse.md#result) + +### Methods + +- [\_\_str\_\_](failsafe.FailsafeReadParametersResponse.md#__str__) +- [is\_error](failsafe.FailsafeReadParametersResponse.md#is_error) +- [parse](failsafe.FailsafeReadParametersResponse.md#parse) + +## Constructors + +### constructor + +• **new FailsafeReadParametersResponse**(): [`FailsafeReadParametersResponse`](failsafe.FailsafeReadParametersResponse.md) + +#### Returns + +[`FailsafeReadParametersResponse`](failsafe.FailsafeReadParametersResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +failsafe.ts:157 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: [`FailsafeReadParametersStructure`](failsafe.FailsafeReadParametersStructure.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +failsafe.ts:156 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/failsafe.FailsafeReadParametersStructure.md b/docs/classes/failsafe.FailsafeReadParametersStructure.md new file mode 100644 index 0000000..3501974 --- /dev/null +++ b/docs/classes/failsafe.FailsafeReadParametersStructure.md @@ -0,0 +1,57 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [failsafe](../modules/failsafe.md) / FailsafeReadParametersStructure + +# Class: FailsafeReadParametersStructure + +[failsafe](../modules/failsafe.md).FailsafeReadParametersStructure + +## Table of contents + +### Constructors + +- [constructor](failsafe.FailsafeReadParametersStructure.md#constructor) + +### Properties + +- [parameters](failsafe.FailsafeReadParametersStructure.md#parameters) +- [safety\_mode](failsafe.FailsafeReadParametersStructure.md#safety_mode) +- [type](failsafe.FailsafeReadParametersStructure.md#type) + +## Constructors + +### constructor + +• **new FailsafeReadParametersStructure**(): [`FailsafeReadParametersStructure`](failsafe.FailsafeReadParametersStructure.md) + +#### Returns + +[`FailsafeReadParametersStructure`](failsafe.FailsafeReadParametersStructure.md) + +## Properties + +### parameters + +• `Optional` **parameters**: [`CPUResponse`](failsafe.CPUResponse.md) \| [`ModuleResponse`](failsafe.ModuleResponse.md) + +#### Defined in + +failsafe.ts:85 + +___ + +### safety\_mode + +• `Optional` **safety\_mode**: `string` + +#### Defined in + +failsafe.ts:83 + +___ + +### type + +• **type**: `string` = `''` + +#### Defined in + +failsafe.ts:84 diff --git a/docs/classes/failsafe.FailsafeReadRuntimeGroups.md b/docs/classes/failsafe.FailsafeReadRuntimeGroups.md new file mode 100644 index 0000000..4e2ed85 --- /dev/null +++ b/docs/classes/failsafe.FailsafeReadRuntimeGroups.md @@ -0,0 +1,382 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [failsafe](../modules/failsafe.md) / FailsafeReadRuntimeGroups + +# Class: FailsafeReadRuntimeGroups + +[failsafe](../modules/failsafe.md).FailsafeReadRuntimeGroups + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`FailsafeReadRuntimeGroups`** + +## Table of contents + +### Constructors + +- [constructor](failsafe.FailsafeReadRuntimeGroups.md#constructor) + +### Properties + +- [address](failsafe.FailsafeReadRuntimeGroups.md#address) +- [method](failsafe.FailsafeReadRuntimeGroups.md#method) +- [params](failsafe.FailsafeReadRuntimeGroups.md#params) +- [plcCertificate](failsafe.FailsafeReadRuntimeGroups.md#plccertificate) +- [protocol](failsafe.FailsafeReadRuntimeGroups.md#protocol) +- [response](failsafe.FailsafeReadRuntimeGroups.md#response) +- [token](failsafe.FailsafeReadRuntimeGroups.md#token) +- [verifyTls](failsafe.FailsafeReadRuntimeGroups.md#verifytls) + +### Methods + +- [\_\_str\_\_](failsafe.FailsafeReadRuntimeGroups.md#__str__) +- [body](failsafe.FailsafeReadRuntimeGroups.md#body) +- [execute](failsafe.FailsafeReadRuntimeGroups.md#execute) +- [format\_response](failsafe.FailsafeReadRuntimeGroups.md#format_response) +- [gethttpsAgent](failsafe.FailsafeReadRuntimeGroups.md#gethttpsagent) +- [headers](failsafe.FailsafeReadRuntimeGroups.md#headers) +- [parse](failsafe.FailsafeReadRuntimeGroups.md#parse) +- [request](failsafe.FailsafeReadRuntimeGroups.md#request) +- [url](failsafe.FailsafeReadRuntimeGroups.md#url) + +## Constructors + +### constructor + +• **new FailsafeReadRuntimeGroups**(`config`, `token`): [`FailsafeReadRuntimeGroups`](failsafe.FailsafeReadRuntimeGroups.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | + +#### Returns + +[`FailsafeReadRuntimeGroups`](failsafe.FailsafeReadRuntimeGroups.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +failsafe.ts:14 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`FailsafeReadRuntimeGroupsResponse`](failsafe.FailsafeReadRuntimeGroupsResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`FailsafeReadRuntimeGroupsResponse`](failsafe.FailsafeReadRuntimeGroupsResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +failsafe.ts:18 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/failsafe.FailsafeReadRuntimeGroupsResponse.md b/docs/classes/failsafe.FailsafeReadRuntimeGroupsResponse.md new file mode 100644 index 0000000..4e59599 --- /dev/null +++ b/docs/classes/failsafe.FailsafeReadRuntimeGroupsResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [failsafe](../modules/failsafe.md) / FailsafeReadRuntimeGroupsResponse + +# Class: FailsafeReadRuntimeGroupsResponse + +[failsafe](../modules/failsafe.md).FailsafeReadRuntimeGroupsResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`FailsafeReadRuntimeGroupsResponse`** + +## Table of contents + +### Constructors + +- [constructor](failsafe.FailsafeReadRuntimeGroupsResponse.md#constructor) + +### Properties + +- [error](failsafe.FailsafeReadRuntimeGroupsResponse.md#error) +- [id](failsafe.FailsafeReadRuntimeGroupsResponse.md#id) +- [kind](failsafe.FailsafeReadRuntimeGroupsResponse.md#kind) +- [result](failsafe.FailsafeReadRuntimeGroupsResponse.md#result) + +### Methods + +- [\_\_str\_\_](failsafe.FailsafeReadRuntimeGroupsResponse.md#__str__) +- [is\_error](failsafe.FailsafeReadRuntimeGroupsResponse.md#is_error) +- [parse](failsafe.FailsafeReadRuntimeGroupsResponse.md#parse) + +## Constructors + +### constructor + +• **new FailsafeReadRuntimeGroupsResponse**(): [`FailsafeReadRuntimeGroupsResponse`](failsafe.FailsafeReadRuntimeGroupsResponse.md) + +#### Returns + +[`FailsafeReadRuntimeGroupsResponse`](failsafe.FailsafeReadRuntimeGroupsResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +failsafe.ts:66 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: [`FailsafeReadRuntimeGroupsStructure`](failsafe.FailsafeReadRuntimeGroupsStructure.md)[] + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +failsafe.ts:65 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/failsafe.FailsafeReadRuntimeGroupsStructure.md b/docs/classes/failsafe.FailsafeReadRuntimeGroupsStructure.md new file mode 100644 index 0000000..0cdd5ab --- /dev/null +++ b/docs/classes/failsafe.FailsafeReadRuntimeGroupsStructure.md @@ -0,0 +1,90 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [failsafe](../modules/failsafe.md) / FailsafeReadRuntimeGroupsStructure + +# Class: FailsafeReadRuntimeGroupsStructure + +[failsafe](../modules/failsafe.md).FailsafeReadRuntimeGroupsStructure + +## Table of contents + +### Constructors + +- [constructor](failsafe.FailsafeReadRuntimeGroupsStructure.md#constructor) + +### Properties + +- [cycle\_time\_current](failsafe.FailsafeReadRuntimeGroupsStructure.md#cycle_time_current) +- [cycle\_time\_max](failsafe.FailsafeReadRuntimeGroupsStructure.md#cycle_time_max) +- [name](failsafe.FailsafeReadRuntimeGroupsStructure.md#name) +- [runtime\_current](failsafe.FailsafeReadRuntimeGroupsStructure.md#runtime_current) +- [runtime\_max](failsafe.FailsafeReadRuntimeGroupsStructure.md#runtime_max) +- [signature](failsafe.FailsafeReadRuntimeGroupsStructure.md#signature) + +## Constructors + +### constructor + +• **new FailsafeReadRuntimeGroupsStructure**(): [`FailsafeReadRuntimeGroupsStructure`](failsafe.FailsafeReadRuntimeGroupsStructure.md) + +#### Returns + +[`FailsafeReadRuntimeGroupsStructure`](failsafe.FailsafeReadRuntimeGroupsStructure.md) + +## Properties + +### cycle\_time\_current + +• **cycle\_time\_current**: `string` = `''` + +#### Defined in + +failsafe.ts:8 + +___ + +### cycle\_time\_max + +• **cycle\_time\_max**: `string` = `''` + +#### Defined in + +failsafe.ts:9 + +___ + +### name + +• **name**: `string` = `''` + +#### Defined in + +failsafe.ts:6 + +___ + +### runtime\_current + +• **runtime\_current**: `string` = `''` + +#### Defined in + +failsafe.ts:10 + +___ + +### runtime\_max + +• **runtime\_max**: `string` = `''` + +#### Defined in + +failsafe.ts:11 + +___ + +### signature + +• **signature**: `string` = `''` + +#### Defined in + +failsafe.ts:7 diff --git a/docs/classes/failsafe.ModuleResponse.md b/docs/classes/failsafe.ModuleResponse.md new file mode 100644 index 0000000..6e03747 --- /dev/null +++ b/docs/classes/failsafe.ModuleResponse.md @@ -0,0 +1,68 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [failsafe](../modules/failsafe.md) / ModuleResponse + +# Class: ModuleResponse + +[failsafe](../modules/failsafe.md).ModuleResponse + +## Table of contents + +### Constructors + +- [constructor](failsafe.ModuleResponse.md#constructor) + +### Properties + +- [f\_destination\_address](failsafe.ModuleResponse.md#f_destination_address) +- [f\_monitoring\_time](failsafe.ModuleResponse.md#f_monitoring_time) +- [f\_par\_crc](failsafe.ModuleResponse.md#f_par_crc) +- [f\_source\_address](failsafe.ModuleResponse.md#f_source_address) + +## Constructors + +### constructor + +• **new ModuleResponse**(): [`ModuleResponse`](failsafe.ModuleResponse.md) + +#### Returns + +[`ModuleResponse`](failsafe.ModuleResponse.md) + +## Properties + +### f\_destination\_address + +• **f\_destination\_address**: `number` = `0` + +#### Defined in + +failsafe.ts:79 + +___ + +### f\_monitoring\_time + +• **f\_monitoring\_time**: `number` = `0` + +#### Defined in + +failsafe.ts:77 + +___ + +### f\_par\_crc + +• **f\_par\_crc**: `number`[] = `[]` + +#### Defined in + +failsafe.ts:80 + +___ + +### f\_source\_address + +• **f\_source\_address**: `number` = `0` + +#### Defined in + +failsafe.ts:78 diff --git a/docs/classes/files.FilesBrowse.md b/docs/classes/files.FilesBrowse.md new file mode 100644 index 0000000..7cc4499 --- /dev/null +++ b/docs/classes/files.FilesBrowse.md @@ -0,0 +1,383 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [files](../modules/files.md) / FilesBrowse + +# Class: FilesBrowse + +[files](../modules/files.md).FilesBrowse + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`FilesBrowse`** + +## Table of contents + +### Constructors + +- [constructor](files.FilesBrowse.md#constructor) + +### Properties + +- [address](files.FilesBrowse.md#address) +- [method](files.FilesBrowse.md#method) +- [params](files.FilesBrowse.md#params) +- [plcCertificate](files.FilesBrowse.md#plccertificate) +- [protocol](files.FilesBrowse.md#protocol) +- [response](files.FilesBrowse.md#response) +- [token](files.FilesBrowse.md#token) +- [verifyTls](files.FilesBrowse.md#verifytls) + +### Methods + +- [\_\_str\_\_](files.FilesBrowse.md#__str__) +- [body](files.FilesBrowse.md#body) +- [execute](files.FilesBrowse.md#execute) +- [format\_response](files.FilesBrowse.md#format_response) +- [gethttpsAgent](files.FilesBrowse.md#gethttpsagent) +- [headers](files.FilesBrowse.md#headers) +- [parse](files.FilesBrowse.md#parse) +- [request](files.FilesBrowse.md#request) +- [url](files.FilesBrowse.md#url) + +## Constructors + +### constructor + +• **new FilesBrowse**(`config`, `token`, `resource?`): [`FilesBrowse`](files.FilesBrowse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `resource?` | `string` | + +#### Returns + +[`FilesBrowse`](files.FilesBrowse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +files.ts:187 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`FilesBrowseResponse`](files.FilesBrowseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`FilesBrowseResponse`](files.FilesBrowseResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +files.ts:197 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/files.FilesBrowseResponse.md b/docs/classes/files.FilesBrowseResponse.md new file mode 100644 index 0000000..5c20c42 --- /dev/null +++ b/docs/classes/files.FilesBrowseResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [files](../modules/files.md) / FilesBrowseResponse + +# Class: FilesBrowseResponse + +[files](../modules/files.md).FilesBrowseResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`FilesBrowseResponse`** + +## Table of contents + +### Constructors + +- [constructor](files.FilesBrowseResponse.md#constructor) + +### Properties + +- [error](files.FilesBrowseResponse.md#error) +- [id](files.FilesBrowseResponse.md#id) +- [kind](files.FilesBrowseResponse.md#kind) +- [result](files.FilesBrowseResponse.md#result) + +### Methods + +- [\_\_str\_\_](files.FilesBrowseResponse.md#__str__) +- [is\_error](files.FilesBrowseResponse.md#is_error) +- [parse](files.FilesBrowseResponse.md#parse) + +## Constructors + +### constructor + +• **new FilesBrowseResponse**(): [`FilesBrowseResponse`](files.FilesBrowseResponse.md) + +#### Returns + +[`FilesBrowseResponse`](files.FilesBrowseResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +files.ts:251 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: [`Resources`](files.Resources.md)[] + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +files.ts:250 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/files.FilesCreate.md b/docs/classes/files.FilesCreate.md new file mode 100644 index 0000000..51b7f09 --- /dev/null +++ b/docs/classes/files.FilesCreate.md @@ -0,0 +1,383 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [files](../modules/files.md) / FilesCreate + +# Class: FilesCreate + +[files](../modules/files.md).FilesCreate + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`FilesCreate`** + +## Table of contents + +### Constructors + +- [constructor](files.FilesCreate.md#constructor) + +### Properties + +- [address](files.FilesCreate.md#address) +- [method](files.FilesCreate.md#method) +- [params](files.FilesCreate.md#params) +- [plcCertificate](files.FilesCreate.md#plccertificate) +- [protocol](files.FilesCreate.md#protocol) +- [response](files.FilesCreate.md#response) +- [token](files.FilesCreate.md#token) +- [verifyTls](files.FilesCreate.md#verifytls) + +### Methods + +- [\_\_str\_\_](files.FilesCreate.md#__str__) +- [body](files.FilesCreate.md#body) +- [execute](files.FilesCreate.md#execute) +- [format\_response](files.FilesCreate.md#format_response) +- [gethttpsAgent](files.FilesCreate.md#gethttpsagent) +- [headers](files.FilesCreate.md#headers) +- [parse](files.FilesCreate.md#parse) +- [request](files.FilesCreate.md#request) +- [url](files.FilesCreate.md#url) + +## Constructors + +### constructor + +• **new FilesCreate**(`config`, `token`, `resource`): [`FilesCreate`](files.FilesCreate.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `resource` | `string` | + +#### Returns + +[`FilesCreate`](files.FilesCreate.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +files.ts:37 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`FilesCreateResponse`](files.FilesCreateResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`FilesCreateResponse`](files.FilesCreateResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +files.ts:43 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/files.FilesCreateDirectory.md b/docs/classes/files.FilesCreateDirectory.md new file mode 100644 index 0000000..104040d --- /dev/null +++ b/docs/classes/files.FilesCreateDirectory.md @@ -0,0 +1,383 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [files](../modules/files.md) / FilesCreateDirectory + +# Class: FilesCreateDirectory + +[files](../modules/files.md).FilesCreateDirectory + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`FilesCreateDirectory`** + +## Table of contents + +### Constructors + +- [constructor](files.FilesCreateDirectory.md#constructor) + +### Properties + +- [address](files.FilesCreateDirectory.md#address) +- [method](files.FilesCreateDirectory.md#method) +- [params](files.FilesCreateDirectory.md#params) +- [plcCertificate](files.FilesCreateDirectory.md#plccertificate) +- [protocol](files.FilesCreateDirectory.md#protocol) +- [response](files.FilesCreateDirectory.md#response) +- [token](files.FilesCreateDirectory.md#token) +- [verifyTls](files.FilesCreateDirectory.md#verifytls) + +### Methods + +- [\_\_str\_\_](files.FilesCreateDirectory.md#__str__) +- [body](files.FilesCreateDirectory.md#body) +- [execute](files.FilesCreateDirectory.md#execute) +- [format\_response](files.FilesCreateDirectory.md#format_response) +- [gethttpsAgent](files.FilesCreateDirectory.md#gethttpsagent) +- [headers](files.FilesCreateDirectory.md#headers) +- [parse](files.FilesCreateDirectory.md#parse) +- [request](files.FilesCreateDirectory.md#request) +- [url](files.FilesCreateDirectory.md#url) + +## Constructors + +### constructor + +• **new FilesCreateDirectory**(`config`, `token`, `resource`): [`FilesCreateDirectory`](files.FilesCreateDirectory.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `resource` | `string` | + +#### Returns + +[`FilesCreateDirectory`](files.FilesCreateDirectory.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +files.ts:92 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`FilesCreateDirectoryResponse`](files.FilesCreateDirectoryResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`FilesCreateDirectoryResponse`](files.FilesCreateDirectoryResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +files.ts:98 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/files.FilesCreateDirectoryResponse.md b/docs/classes/files.FilesCreateDirectoryResponse.md new file mode 100644 index 0000000..c6bb93d --- /dev/null +++ b/docs/classes/files.FilesCreateDirectoryResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [files](../modules/files.md) / FilesCreateDirectoryResponse + +# Class: FilesCreateDirectoryResponse + +[files](../modules/files.md).FilesCreateDirectoryResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`FilesCreateDirectoryResponse`** + +## Table of contents + +### Constructors + +- [constructor](files.FilesCreateDirectoryResponse.md#constructor) + +### Properties + +- [error](files.FilesCreateDirectoryResponse.md#error) +- [id](files.FilesCreateDirectoryResponse.md#id) +- [kind](files.FilesCreateDirectoryResponse.md#kind) +- [result](files.FilesCreateDirectoryResponse.md#result) + +### Methods + +- [\_\_str\_\_](files.FilesCreateDirectoryResponse.md#__str__) +- [is\_error](files.FilesCreateDirectoryResponse.md#is_error) +- [parse](files.FilesCreateDirectoryResponse.md#parse) + +## Constructors + +### constructor + +• **new FilesCreateDirectoryResponse**(): [`FilesCreateDirectoryResponse`](files.FilesCreateDirectoryResponse.md) + +#### Returns + +[`FilesCreateDirectoryResponse`](files.FilesCreateDirectoryResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +files.ts:114 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +files.ts:113 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/files.FilesCreateResponse.md b/docs/classes/files.FilesCreateResponse.md new file mode 100644 index 0000000..62f51dd --- /dev/null +++ b/docs/classes/files.FilesCreateResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [files](../modules/files.md) / FilesCreateResponse + +# Class: FilesCreateResponse + +[files](../modules/files.md).FilesCreateResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`FilesCreateResponse`** + +## Table of contents + +### Constructors + +- [constructor](files.FilesCreateResponse.md#constructor) + +### Properties + +- [error](files.FilesCreateResponse.md#error) +- [id](files.FilesCreateResponse.md#id) +- [kind](files.FilesCreateResponse.md#kind) +- [result](files.FilesCreateResponse.md#result) + +### Methods + +- [\_\_str\_\_](files.FilesCreateResponse.md#__str__) +- [is\_error](files.FilesCreateResponse.md#is_error) +- [parse](files.FilesCreateResponse.md#parse) + +## Constructors + +### constructor + +• **new FilesCreateResponse**(): [`FilesCreateResponse`](files.FilesCreateResponse.md) + +#### Returns + +[`FilesCreateResponse`](files.FilesCreateResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +files.ts:60 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `string` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +files.ts:59 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/files.FilesDelete.md b/docs/classes/files.FilesDelete.md new file mode 100644 index 0000000..04996c1 --- /dev/null +++ b/docs/classes/files.FilesDelete.md @@ -0,0 +1,383 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [files](../modules/files.md) / FilesDelete + +# Class: FilesDelete + +[files](../modules/files.md).FilesDelete + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`FilesDelete`** + +## Table of contents + +### Constructors + +- [constructor](files.FilesDelete.md#constructor) + +### Properties + +- [address](files.FilesDelete.md#address) +- [method](files.FilesDelete.md#method) +- [params](files.FilesDelete.md#params) +- [plcCertificate](files.FilesDelete.md#plccertificate) +- [protocol](files.FilesDelete.md#protocol) +- [response](files.FilesDelete.md#response) +- [token](files.FilesDelete.md#token) +- [verifyTls](files.FilesDelete.md#verifytls) + +### Methods + +- [\_\_str\_\_](files.FilesDelete.md#__str__) +- [body](files.FilesDelete.md#body) +- [execute](files.FilesDelete.md#execute) +- [format\_response](files.FilesDelete.md#format_response) +- [gethttpsAgent](files.FilesDelete.md#gethttpsagent) +- [headers](files.FilesDelete.md#headers) +- [parse](files.FilesDelete.md#parse) +- [request](files.FilesDelete.md#request) +- [url](files.FilesDelete.md#url) + +## Constructors + +### constructor + +• **new FilesDelete**(`config`, `token`, `resource`): [`FilesDelete`](files.FilesDelete.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `resource` | `string` | + +#### Returns + +[`FilesDelete`](files.FilesDelete.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +files.ts:65 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`FilesDeleteResponse`](files.FilesDeleteResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`FilesDeleteResponse`](files.FilesDeleteResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +files.ts:71 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/files.FilesDeleteDirectory.md b/docs/classes/files.FilesDeleteDirectory.md new file mode 100644 index 0000000..380d561 --- /dev/null +++ b/docs/classes/files.FilesDeleteDirectory.md @@ -0,0 +1,383 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [files](../modules/files.md) / FilesDeleteDirectory + +# Class: FilesDeleteDirectory + +[files](../modules/files.md).FilesDeleteDirectory + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`FilesDeleteDirectory`** + +## Table of contents + +### Constructors + +- [constructor](files.FilesDeleteDirectory.md#constructor) + +### Properties + +- [address](files.FilesDeleteDirectory.md#address) +- [method](files.FilesDeleteDirectory.md#method) +- [params](files.FilesDeleteDirectory.md#params) +- [plcCertificate](files.FilesDeleteDirectory.md#plccertificate) +- [protocol](files.FilesDeleteDirectory.md#protocol) +- [response](files.FilesDeleteDirectory.md#response) +- [token](files.FilesDeleteDirectory.md#token) +- [verifyTls](files.FilesDeleteDirectory.md#verifytls) + +### Methods + +- [\_\_str\_\_](files.FilesDeleteDirectory.md#__str__) +- [body](files.FilesDeleteDirectory.md#body) +- [execute](files.FilesDeleteDirectory.md#execute) +- [format\_response](files.FilesDeleteDirectory.md#format_response) +- [gethttpsAgent](files.FilesDeleteDirectory.md#gethttpsagent) +- [headers](files.FilesDeleteDirectory.md#headers) +- [parse](files.FilesDeleteDirectory.md#parse) +- [request](files.FilesDeleteDirectory.md#request) +- [url](files.FilesDeleteDirectory.md#url) + +## Constructors + +### constructor + +• **new FilesDeleteDirectory**(`config`, `token`, `resource`): [`FilesDeleteDirectory`](files.FilesDeleteDirectory.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `resource` | `string` | + +#### Returns + +[`FilesDeleteDirectory`](files.FilesDeleteDirectory.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +files.ts:120 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`FilesDeleteDirectoryResponse`](files.FilesDeleteDirectoryResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`FilesDeleteDirectoryResponse`](files.FilesDeleteDirectoryResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +files.ts:126 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/files.FilesDeleteDirectoryResponse.md b/docs/classes/files.FilesDeleteDirectoryResponse.md new file mode 100644 index 0000000..2258141 --- /dev/null +++ b/docs/classes/files.FilesDeleteDirectoryResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [files](../modules/files.md) / FilesDeleteDirectoryResponse + +# Class: FilesDeleteDirectoryResponse + +[files](../modules/files.md).FilesDeleteDirectoryResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`FilesDeleteDirectoryResponse`** + +## Table of contents + +### Constructors + +- [constructor](files.FilesDeleteDirectoryResponse.md#constructor) + +### Properties + +- [error](files.FilesDeleteDirectoryResponse.md#error) +- [id](files.FilesDeleteDirectoryResponse.md#id) +- [kind](files.FilesDeleteDirectoryResponse.md#kind) +- [result](files.FilesDeleteDirectoryResponse.md#result) + +### Methods + +- [\_\_str\_\_](files.FilesDeleteDirectoryResponse.md#__str__) +- [is\_error](files.FilesDeleteDirectoryResponse.md#is_error) +- [parse](files.FilesDeleteDirectoryResponse.md#parse) + +## Constructors + +### constructor + +• **new FilesDeleteDirectoryResponse**(): [`FilesDeleteDirectoryResponse`](files.FilesDeleteDirectoryResponse.md) + +#### Returns + +[`FilesDeleteDirectoryResponse`](files.FilesDeleteDirectoryResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +files.ts:142 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +files.ts:141 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/files.FilesDeleteResponse.md b/docs/classes/files.FilesDeleteResponse.md new file mode 100644 index 0000000..204fc82 --- /dev/null +++ b/docs/classes/files.FilesDeleteResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [files](../modules/files.md) / FilesDeleteResponse + +# Class: FilesDeleteResponse + +[files](../modules/files.md).FilesDeleteResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`FilesDeleteResponse`** + +## Table of contents + +### Constructors + +- [constructor](files.FilesDeleteResponse.md#constructor) + +### Properties + +- [error](files.FilesDeleteResponse.md#error) +- [id](files.FilesDeleteResponse.md#id) +- [kind](files.FilesDeleteResponse.md#kind) +- [result](files.FilesDeleteResponse.md#result) + +### Methods + +- [\_\_str\_\_](files.FilesDeleteResponse.md#__str__) +- [is\_error](files.FilesDeleteResponse.md#is_error) +- [parse](files.FilesDeleteResponse.md#parse) + +## Constructors + +### constructor + +• **new FilesDeleteResponse**(): [`FilesDeleteResponse`](files.FilesDeleteResponse.md) + +#### Returns + +[`FilesDeleteResponse`](files.FilesDeleteResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +files.ts:87 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +files.ts:86 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/files.FilesDownload.md b/docs/classes/files.FilesDownload.md new file mode 100644 index 0000000..1c41973 --- /dev/null +++ b/docs/classes/files.FilesDownload.md @@ -0,0 +1,383 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [files](../modules/files.md) / FilesDownload + +# Class: FilesDownload + +[files](../modules/files.md).FilesDownload + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`FilesDownload`** + +## Table of contents + +### Constructors + +- [constructor](files.FilesDownload.md#constructor) + +### Properties + +- [address](files.FilesDownload.md#address) +- [method](files.FilesDownload.md#method) +- [params](files.FilesDownload.md#params) +- [plcCertificate](files.FilesDownload.md#plccertificate) +- [protocol](files.FilesDownload.md#protocol) +- [response](files.FilesDownload.md#response) +- [token](files.FilesDownload.md#token) +- [verifyTls](files.FilesDownload.md#verifytls) + +### Methods + +- [\_\_str\_\_](files.FilesDownload.md#__str__) +- [body](files.FilesDownload.md#body) +- [execute](files.FilesDownload.md#execute) +- [format\_response](files.FilesDownload.md#format_response) +- [gethttpsAgent](files.FilesDownload.md#gethttpsagent) +- [headers](files.FilesDownload.md#headers) +- [parse](files.FilesDownload.md#parse) +- [request](files.FilesDownload.md#request) +- [url](files.FilesDownload.md#url) + +## Constructors + +### constructor + +• **new FilesDownload**(`config`, `token`, `resource`): [`FilesDownload`](files.FilesDownload.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `resource` | `string` | + +#### Returns + +[`FilesDownload`](files.FilesDownload.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +files.ts:6 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`FilesDownloadResponse`](files.FilesDownloadResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`FilesDownloadResponse`](files.FilesDownloadResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +files.ts:12 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/files.FilesDownloadResponse.md b/docs/classes/files.FilesDownloadResponse.md new file mode 100644 index 0000000..03a96d2 --- /dev/null +++ b/docs/classes/files.FilesDownloadResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [files](../modules/files.md) / FilesDownloadResponse + +# Class: FilesDownloadResponse + +[files](../modules/files.md).FilesDownloadResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`FilesDownloadResponse`** + +## Table of contents + +### Constructors + +- [constructor](files.FilesDownloadResponse.md#constructor) + +### Properties + +- [error](files.FilesDownloadResponse.md#error) +- [id](files.FilesDownloadResponse.md#id) +- [kind](files.FilesDownloadResponse.md#kind) +- [result](files.FilesDownloadResponse.md#result) + +### Methods + +- [\_\_str\_\_](files.FilesDownloadResponse.md#__str__) +- [is\_error](files.FilesDownloadResponse.md#is_error) +- [parse](files.FilesDownloadResponse.md#parse) + +## Constructors + +### constructor + +• **new FilesDownloadResponse**(): [`FilesDownloadResponse`](files.FilesDownloadResponse.md) + +#### Returns + +[`FilesDownloadResponse`](files.FilesDownloadResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +files.ts:31 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `string` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +files.ts:30 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/files.FilesRename.md b/docs/classes/files.FilesRename.md new file mode 100644 index 0000000..84c7dc4 --- /dev/null +++ b/docs/classes/files.FilesRename.md @@ -0,0 +1,384 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [files](../modules/files.md) / FilesRename + +# Class: FilesRename + +[files](../modules/files.md).FilesRename + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`FilesRename`** + +## Table of contents + +### Constructors + +- [constructor](files.FilesRename.md#constructor) + +### Properties + +- [address](files.FilesRename.md#address) +- [method](files.FilesRename.md#method) +- [params](files.FilesRename.md#params) +- [plcCertificate](files.FilesRename.md#plccertificate) +- [protocol](files.FilesRename.md#protocol) +- [response](files.FilesRename.md#response) +- [token](files.FilesRename.md#token) +- [verifyTls](files.FilesRename.md#verifytls) + +### Methods + +- [\_\_str\_\_](files.FilesRename.md#__str__) +- [body](files.FilesRename.md#body) +- [execute](files.FilesRename.md#execute) +- [format\_response](files.FilesRename.md#format_response) +- [gethttpsAgent](files.FilesRename.md#gethttpsagent) +- [headers](files.FilesRename.md#headers) +- [parse](files.FilesRename.md#parse) +- [request](files.FilesRename.md#request) +- [url](files.FilesRename.md#url) + +## Constructors + +### constructor + +• **new FilesRename**(`config`, `token`, `resource`, `new_resource`): [`FilesRename`](files.FilesRename.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `resource` | `string` | +| `new_resource` | `string` | + +#### Returns + +[`FilesRename`](files.FilesRename.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +files.ts:148 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`FilesRenameResponse`](files.FilesRenameResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`FilesRenameResponse`](files.FilesRenameResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +files.ts:154 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/files.FilesRenameResponse.md b/docs/classes/files.FilesRenameResponse.md new file mode 100644 index 0000000..28543c3 --- /dev/null +++ b/docs/classes/files.FilesRenameResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [files](../modules/files.md) / FilesRenameResponse + +# Class: FilesRenameResponse + +[files](../modules/files.md).FilesRenameResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`FilesRenameResponse`** + +## Table of contents + +### Constructors + +- [constructor](files.FilesRenameResponse.md#constructor) + +### Properties + +- [error](files.FilesRenameResponse.md#error) +- [id](files.FilesRenameResponse.md#id) +- [kind](files.FilesRenameResponse.md#kind) +- [result](files.FilesRenameResponse.md#result) + +### Methods + +- [\_\_str\_\_](files.FilesRenameResponse.md#__str__) +- [is\_error](files.FilesRenameResponse.md#is_error) +- [parse](files.FilesRenameResponse.md#parse) + +## Constructors + +### constructor + +• **new FilesRenameResponse**(): [`FilesRenameResponse`](files.FilesRenameResponse.md) + +#### Returns + +[`FilesRenameResponse`](files.FilesRenameResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +files.ts:172 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +files.ts:170 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/files.Resources.md b/docs/classes/files.Resources.md new file mode 100644 index 0000000..dc02a44 --- /dev/null +++ b/docs/classes/files.Resources.md @@ -0,0 +1,79 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [files](../modules/files.md) / Resources + +# Class: Resources + +[files](../modules/files.md).Resources + +## Table of contents + +### Constructors + +- [constructor](files.Resources.md#constructor) + +### Properties + +- [last\_modified](files.Resources.md#last_modified) +- [name](files.Resources.md#name) +- [size](files.Resources.md#size) +- [state](files.Resources.md#state) +- [type](files.Resources.md#type) + +## Constructors + +### constructor + +• **new Resources**(): [`Resources`](files.Resources.md) + +#### Returns + +[`Resources`](files.Resources.md) + +## Properties + +### last\_modified + +• **last\_modified**: `string` = `''` + +#### Defined in + +files.ts:181 + +___ + +### name + +• **name**: `string` = `''` + +#### Defined in + +files.ts:178 + +___ + +### size + +• `Optional` **size**: `number` + +#### Defined in + +files.ts:180 + +___ + +### state + +• `Optional` **state**: `string` + +#### Defined in + +files.ts:182 + +___ + +### type + +• **type**: `string` = `''` + +#### Defined in + +files.ts:179 diff --git a/docs/classes/plc.PlcCreateBackup.md b/docs/classes/plc.PlcCreateBackup.md new file mode 100644 index 0000000..a852c7c --- /dev/null +++ b/docs/classes/plc.PlcCreateBackup.md @@ -0,0 +1,382 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / PlcCreateBackup + +# Class: PlcCreateBackup + +[plc](../modules/plc.md).PlcCreateBackup + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`PlcCreateBackup`** + +## Table of contents + +### Constructors + +- [constructor](plc.PlcCreateBackup.md#constructor) + +### Properties + +- [address](plc.PlcCreateBackup.md#address) +- [method](plc.PlcCreateBackup.md#method) +- [params](plc.PlcCreateBackup.md#params) +- [plcCertificate](plc.PlcCreateBackup.md#plccertificate) +- [protocol](plc.PlcCreateBackup.md#protocol) +- [response](plc.PlcCreateBackup.md#response) +- [token](plc.PlcCreateBackup.md#token) +- [verifyTls](plc.PlcCreateBackup.md#verifytls) + +### Methods + +- [\_\_str\_\_](plc.PlcCreateBackup.md#__str__) +- [body](plc.PlcCreateBackup.md#body) +- [execute](plc.PlcCreateBackup.md#execute) +- [format\_response](plc.PlcCreateBackup.md#format_response) +- [gethttpsAgent](plc.PlcCreateBackup.md#gethttpsagent) +- [headers](plc.PlcCreateBackup.md#headers) +- [parse](plc.PlcCreateBackup.md#parse) +- [request](plc.PlcCreateBackup.md#request) +- [url](plc.PlcCreateBackup.md#url) + +## Constructors + +### constructor + +• **new PlcCreateBackup**(`config`, `token`): [`PlcCreateBackup`](plc.PlcCreateBackup.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | + +#### Returns + +[`PlcCreateBackup`](plc.PlcCreateBackup.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +plc.ts:334 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`PlcCreateBackupResponse`](plc.PlcCreateBackupResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`PlcCreateBackupResponse`](plc.PlcCreateBackupResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +plc.ts:339 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/plc.PlcCreateBackupResponse.md b/docs/classes/plc.PlcCreateBackupResponse.md new file mode 100644 index 0000000..51882b2 --- /dev/null +++ b/docs/classes/plc.PlcCreateBackupResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / PlcCreateBackupResponse + +# Class: PlcCreateBackupResponse + +[plc](../modules/plc.md).PlcCreateBackupResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`PlcCreateBackupResponse`** + +## Table of contents + +### Constructors + +- [constructor](plc.PlcCreateBackupResponse.md#constructor) + +### Properties + +- [error](plc.PlcCreateBackupResponse.md#error) +- [id](plc.PlcCreateBackupResponse.md#id) +- [kind](plc.PlcCreateBackupResponse.md#kind) +- [result](plc.PlcCreateBackupResponse.md#result) + +### Methods + +- [\_\_str\_\_](plc.PlcCreateBackupResponse.md#__str__) +- [is\_error](plc.PlcCreateBackupResponse.md#is_error) +- [parse](plc.PlcCreateBackupResponse.md#parse) + +## Constructors + +### constructor + +• **new PlcCreateBackupResponse**(): [`PlcCreateBackupResponse`](plc.PlcCreateBackupResponse.md) + +#### Returns + +[`PlcCreateBackupResponse`](plc.PlcCreateBackupResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +plc.ts:356 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `string` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +plc.ts:355 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/plc.PlcReadOperatingMode.md b/docs/classes/plc.PlcReadOperatingMode.md new file mode 100644 index 0000000..524e249 --- /dev/null +++ b/docs/classes/plc.PlcReadOperatingMode.md @@ -0,0 +1,382 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / PlcReadOperatingMode + +# Class: PlcReadOperatingMode + +[plc](../modules/plc.md).PlcReadOperatingMode + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`PlcReadOperatingMode`** + +## Table of contents + +### Constructors + +- [constructor](plc.PlcReadOperatingMode.md#constructor) + +### Properties + +- [address](plc.PlcReadOperatingMode.md#address) +- [method](plc.PlcReadOperatingMode.md#method) +- [params](plc.PlcReadOperatingMode.md#params) +- [plcCertificate](plc.PlcReadOperatingMode.md#plccertificate) +- [protocol](plc.PlcReadOperatingMode.md#protocol) +- [response](plc.PlcReadOperatingMode.md#response) +- [token](plc.PlcReadOperatingMode.md#token) +- [verifyTls](plc.PlcReadOperatingMode.md#verifytls) + +### Methods + +- [\_\_str\_\_](plc.PlcReadOperatingMode.md#__str__) +- [body](plc.PlcReadOperatingMode.md#body) +- [execute](plc.PlcReadOperatingMode.md#execute) +- [format\_response](plc.PlcReadOperatingMode.md#format_response) +- [gethttpsAgent](plc.PlcReadOperatingMode.md#gethttpsagent) +- [headers](plc.PlcReadOperatingMode.md#headers) +- [parse](plc.PlcReadOperatingMode.md#parse) +- [request](plc.PlcReadOperatingMode.md#request) +- [url](plc.PlcReadOperatingMode.md#url) + +## Constructors + +### constructor + +• **new PlcReadOperatingMode**(`config`, `token`): [`PlcReadOperatingMode`](plc.PlcReadOperatingMode.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | + +#### Returns + +[`PlcReadOperatingMode`](plc.PlcReadOperatingMode.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +plc.ts:28 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`PlcReadOperatingModeResponse`](plc.PlcReadOperatingModeResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`PlcReadOperatingModeResponse`](plc.PlcReadOperatingModeResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +plc.ts:34 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/plc.PlcReadOperatingModeResponse.md b/docs/classes/plc.PlcReadOperatingModeResponse.md new file mode 100644 index 0000000..0c9fc96 --- /dev/null +++ b/docs/classes/plc.PlcReadOperatingModeResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / PlcReadOperatingModeResponse + +# Class: PlcReadOperatingModeResponse + +[plc](../modules/plc.md).PlcReadOperatingModeResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`PlcReadOperatingModeResponse`** + +## Table of contents + +### Constructors + +- [constructor](plc.PlcReadOperatingModeResponse.md#constructor) + +### Properties + +- [error](plc.PlcReadOperatingModeResponse.md#error) +- [id](plc.PlcReadOperatingModeResponse.md#id) +- [kind](plc.PlcReadOperatingModeResponse.md#kind) +- [result](plc.PlcReadOperatingModeResponse.md#result) + +### Methods + +- [\_\_str\_\_](plc.PlcReadOperatingModeResponse.md#__str__) +- [is\_error](plc.PlcReadOperatingModeResponse.md#is_error) +- [parse](plc.PlcReadOperatingModeResponse.md#parse) + +## Constructors + +### constructor + +• **new PlcReadOperatingModeResponse**(): [`PlcReadOperatingModeResponse`](plc.PlcReadOperatingModeResponse.md) + +#### Returns + +[`PlcReadOperatingModeResponse`](plc.PlcReadOperatingModeResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +plc.ts:56 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `string` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +plc.ts:55 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/plc.PlcReadSystemTime.md b/docs/classes/plc.PlcReadSystemTime.md new file mode 100644 index 0000000..d6301c6 --- /dev/null +++ b/docs/classes/plc.PlcReadSystemTime.md @@ -0,0 +1,381 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / PlcReadSystemTime + +# Class: PlcReadSystemTime + +[plc](../modules/plc.md).PlcReadSystemTime + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`PlcReadSystemTime`** + +## Table of contents + +### Constructors + +- [constructor](plc.PlcReadSystemTime.md#constructor) + +### Properties + +- [address](plc.PlcReadSystemTime.md#address) +- [method](plc.PlcReadSystemTime.md#method) +- [params](plc.PlcReadSystemTime.md#params) +- [plcCertificate](plc.PlcReadSystemTime.md#plccertificate) +- [protocol](plc.PlcReadSystemTime.md#protocol) +- [response](plc.PlcReadSystemTime.md#response) +- [token](plc.PlcReadSystemTime.md#token) +- [verifyTls](plc.PlcReadSystemTime.md#verifytls) + +### Methods + +- [\_\_str\_\_](plc.PlcReadSystemTime.md#__str__) +- [body](plc.PlcReadSystemTime.md#body) +- [execute](plc.PlcReadSystemTime.md#execute) +- [format\_response](plc.PlcReadSystemTime.md#format_response) +- [gethttpsAgent](plc.PlcReadSystemTime.md#gethttpsagent) +- [headers](plc.PlcReadSystemTime.md#headers) +- [parse](plc.PlcReadSystemTime.md#parse) +- [request](plc.PlcReadSystemTime.md#request) +- [url](plc.PlcReadSystemTime.md#url) + +## Constructors + +### constructor + +• **new PlcReadSystemTime**(`config`): [`PlcReadSystemTime`](plc.PlcReadSystemTime.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | + +#### Returns + +[`PlcReadSystemTime`](plc.PlcReadSystemTime.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +plc.ts:97 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`PlcReadSystemTimeResponse`](plc.PlcReadSystemTimeResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`PlcReadSystemTimeResponse`](plc.PlcReadSystemTimeResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +plc.ts:103 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/plc.PlcReadSystemTimeResponse.md b/docs/classes/plc.PlcReadSystemTimeResponse.md new file mode 100644 index 0000000..6bd02b3 --- /dev/null +++ b/docs/classes/plc.PlcReadSystemTimeResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / PlcReadSystemTimeResponse + +# Class: PlcReadSystemTimeResponse + +[plc](../modules/plc.md).PlcReadSystemTimeResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`PlcReadSystemTimeResponse`** + +## Table of contents + +### Constructors + +- [constructor](plc.PlcReadSystemTimeResponse.md#constructor) + +### Properties + +- [error](plc.PlcReadSystemTimeResponse.md#error) +- [id](plc.PlcReadSystemTimeResponse.md#id) +- [kind](plc.PlcReadSystemTimeResponse.md#kind) +- [result](plc.PlcReadSystemTimeResponse.md#result) + +### Methods + +- [\_\_str\_\_](plc.PlcReadSystemTimeResponse.md#__str__) +- [is\_error](plc.PlcReadSystemTimeResponse.md#is_error) +- [parse](plc.PlcReadSystemTimeResponse.md#parse) + +## Constructors + +### constructor + +• **new PlcReadSystemTimeResponse**(): [`PlcReadSystemTimeResponse`](plc.PlcReadSystemTimeResponse.md) + +#### Returns + +[`PlcReadSystemTimeResponse`](plc.PlcReadSystemTimeResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +plc.ts:124 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `Date` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +plc.ts:123 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/plc.PlcReadTimeSettings.md b/docs/classes/plc.PlcReadTimeSettings.md new file mode 100644 index 0000000..ffbdfdd --- /dev/null +++ b/docs/classes/plc.PlcReadTimeSettings.md @@ -0,0 +1,381 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / PlcReadTimeSettings + +# Class: PlcReadTimeSettings + +[plc](../modules/plc.md).PlcReadTimeSettings + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`PlcReadTimeSettings`** + +## Table of contents + +### Constructors + +- [constructor](plc.PlcReadTimeSettings.md#constructor) + +### Properties + +- [address](plc.PlcReadTimeSettings.md#address) +- [method](plc.PlcReadTimeSettings.md#method) +- [params](plc.PlcReadTimeSettings.md#params) +- [plcCertificate](plc.PlcReadTimeSettings.md#plccertificate) +- [protocol](plc.PlcReadTimeSettings.md#protocol) +- [response](plc.PlcReadTimeSettings.md#response) +- [token](plc.PlcReadTimeSettings.md#token) +- [verifyTls](plc.PlcReadTimeSettings.md#verifytls) + +### Methods + +- [\_\_str\_\_](plc.PlcReadTimeSettings.md#__str__) +- [body](plc.PlcReadTimeSettings.md#body) +- [execute](plc.PlcReadTimeSettings.md#execute) +- [format\_response](plc.PlcReadTimeSettings.md#format_response) +- [gethttpsAgent](plc.PlcReadTimeSettings.md#gethttpsagent) +- [headers](plc.PlcReadTimeSettings.md#headers) +- [parse](plc.PlcReadTimeSettings.md#parse) +- [request](plc.PlcReadTimeSettings.md#request) +- [url](plc.PlcReadTimeSettings.md#url) + +## Constructors + +### constructor + +• **new PlcReadTimeSettings**(`config`): [`PlcReadTimeSettings`](plc.PlcReadTimeSettings.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | + +#### Returns + +[`PlcReadTimeSettings`](plc.PlcReadTimeSettings.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +plc.ts:186 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`PlcReadTimeSettingsResponse`](plc.PlcReadTimeSettingsResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`PlcReadTimeSettingsResponse`](plc.PlcReadTimeSettingsResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +plc.ts:190 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/plc.PlcReadTimeSettingsResponse.md b/docs/classes/plc.PlcReadTimeSettingsResponse.md new file mode 100644 index 0000000..857dc87 --- /dev/null +++ b/docs/classes/plc.PlcReadTimeSettingsResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / PlcReadTimeSettingsResponse + +# Class: PlcReadTimeSettingsResponse + +[plc](../modules/plc.md).PlcReadTimeSettingsResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`PlcReadTimeSettingsResponse`** + +## Table of contents + +### Constructors + +- [constructor](plc.PlcReadTimeSettingsResponse.md#constructor) + +### Properties + +- [error](plc.PlcReadTimeSettingsResponse.md#error) +- [id](plc.PlcReadTimeSettingsResponse.md#id) +- [kind](plc.PlcReadTimeSettingsResponse.md#kind) +- [result](plc.PlcReadTimeSettingsResponse.md#result) + +### Methods + +- [\_\_str\_\_](plc.PlcReadTimeSettingsResponse.md#__str__) +- [is\_error](plc.PlcReadTimeSettingsResponse.md#is_error) +- [parse](plc.PlcReadTimeSettingsResponse.md#parse) + +## Constructors + +### constructor + +• **new PlcReadTimeSettingsResponse**(): [`PlcReadTimeSettingsResponse`](plc.PlcReadTimeSettingsResponse.md) + +#### Returns + +[`PlcReadTimeSettingsResponse`](plc.PlcReadTimeSettingsResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +plc.ts:259 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: [`TimeSettings`](plc.TimeSettings.md)[] + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +plc.ts:258 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/plc.PlcRequestChangeOperatingMode.md b/docs/classes/plc.PlcRequestChangeOperatingMode.md new file mode 100644 index 0000000..d741f4e --- /dev/null +++ b/docs/classes/plc.PlcRequestChangeOperatingMode.md @@ -0,0 +1,383 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / PlcRequestChangeOperatingMode + +# Class: PlcRequestChangeOperatingMode + +[plc](../modules/plc.md).PlcRequestChangeOperatingMode + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`PlcRequestChangeOperatingMode`** + +## Table of contents + +### Constructors + +- [constructor](plc.PlcRequestChangeOperatingMode.md#constructor) + +### Properties + +- [address](plc.PlcRequestChangeOperatingMode.md#address) +- [method](plc.PlcRequestChangeOperatingMode.md#method) +- [params](plc.PlcRequestChangeOperatingMode.md#params) +- [plcCertificate](plc.PlcRequestChangeOperatingMode.md#plccertificate) +- [protocol](plc.PlcRequestChangeOperatingMode.md#protocol) +- [response](plc.PlcRequestChangeOperatingMode.md#response) +- [token](plc.PlcRequestChangeOperatingMode.md#token) +- [verifyTls](plc.PlcRequestChangeOperatingMode.md#verifytls) + +### Methods + +- [\_\_str\_\_](plc.PlcRequestChangeOperatingMode.md#__str__) +- [body](plc.PlcRequestChangeOperatingMode.md#body) +- [execute](plc.PlcRequestChangeOperatingMode.md#execute) +- [format\_response](plc.PlcRequestChangeOperatingMode.md#format_response) +- [gethttpsAgent](plc.PlcRequestChangeOperatingMode.md#gethttpsagent) +- [headers](plc.PlcRequestChangeOperatingMode.md#headers) +- [parse](plc.PlcRequestChangeOperatingMode.md#parse) +- [request](plc.PlcRequestChangeOperatingMode.md#request) +- [url](plc.PlcRequestChangeOperatingMode.md#url) + +## Constructors + +### constructor + +• **new PlcRequestChangeOperatingMode**(`config`, `token`, `mode`): [`PlcRequestChangeOperatingMode`](plc.PlcRequestChangeOperatingMode.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `mode` | [`PlcOpertingMode`](../enums/plc.PlcOpertingMode.md) | + +#### Returns + +[`PlcRequestChangeOperatingMode`](plc.PlcRequestChangeOperatingMode.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +plc.ts:62 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`PlcRequestChangeOperatingModeResponse`](plc.PlcRequestChangeOperatingModeResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`PlcRequestChangeOperatingModeResponse`](plc.PlcRequestChangeOperatingModeResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +plc.ts:76 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/plc.PlcRequestChangeOperatingModeResponse.md b/docs/classes/plc.PlcRequestChangeOperatingModeResponse.md new file mode 100644 index 0000000..42cbd12 --- /dev/null +++ b/docs/classes/plc.PlcRequestChangeOperatingModeResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / PlcRequestChangeOperatingModeResponse + +# Class: PlcRequestChangeOperatingModeResponse + +[plc](../modules/plc.md).PlcRequestChangeOperatingModeResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`PlcRequestChangeOperatingModeResponse`** + +## Table of contents + +### Constructors + +- [constructor](plc.PlcRequestChangeOperatingModeResponse.md#constructor) + +### Properties + +- [error](plc.PlcRequestChangeOperatingModeResponse.md#error) +- [id](plc.PlcRequestChangeOperatingModeResponse.md#id) +- [kind](plc.PlcRequestChangeOperatingModeResponse.md#kind) +- [result](plc.PlcRequestChangeOperatingModeResponse.md#result) + +### Methods + +- [\_\_str\_\_](plc.PlcRequestChangeOperatingModeResponse.md#__str__) +- [is\_error](plc.PlcRequestChangeOperatingModeResponse.md#is_error) +- [parse](plc.PlcRequestChangeOperatingModeResponse.md#parse) + +## Constructors + +### constructor + +• **new PlcRequestChangeOperatingModeResponse**(): [`PlcRequestChangeOperatingModeResponse`](plc.PlcRequestChangeOperatingModeResponse.md) + +#### Returns + +[`PlcRequestChangeOperatingModeResponse`](plc.PlcRequestChangeOperatingModeResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +plc.ts:92 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +plc.ts:91 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/plc.PlcRestoreBackup.md b/docs/classes/plc.PlcRestoreBackup.md new file mode 100644 index 0000000..0506124 --- /dev/null +++ b/docs/classes/plc.PlcRestoreBackup.md @@ -0,0 +1,383 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / PlcRestoreBackup + +# Class: PlcRestoreBackup + +[plc](../modules/plc.md).PlcRestoreBackup + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`PlcRestoreBackup`** + +## Table of contents + +### Constructors + +- [constructor](plc.PlcRestoreBackup.md#constructor) + +### Properties + +- [address](plc.PlcRestoreBackup.md#address) +- [method](plc.PlcRestoreBackup.md#method) +- [params](plc.PlcRestoreBackup.md#params) +- [plcCertificate](plc.PlcRestoreBackup.md#plccertificate) +- [protocol](plc.PlcRestoreBackup.md#protocol) +- [response](plc.PlcRestoreBackup.md#response) +- [token](plc.PlcRestoreBackup.md#token) +- [verifyTls](plc.PlcRestoreBackup.md#verifytls) + +### Methods + +- [\_\_str\_\_](plc.PlcRestoreBackup.md#__str__) +- [body](plc.PlcRestoreBackup.md#body) +- [execute](plc.PlcRestoreBackup.md#execute) +- [format\_response](plc.PlcRestoreBackup.md#format_response) +- [gethttpsAgent](plc.PlcRestoreBackup.md#gethttpsagent) +- [headers](plc.PlcRestoreBackup.md#headers) +- [parse](plc.PlcRestoreBackup.md#parse) +- [request](plc.PlcRestoreBackup.md#request) +- [url](plc.PlcRestoreBackup.md#url) + +## Constructors + +### constructor + +• **new PlcRestoreBackup**(`config`, `token`, `password`): [`PlcRestoreBackup`](plc.PlcRestoreBackup.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `password` | `string` | + +#### Returns + +[`PlcRestoreBackup`](plc.PlcRestoreBackup.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +plc.ts:361 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`PlcRestoreBackupResponse`](plc.PlcRestoreBackupResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`PlcRestoreBackupResponse`](plc.PlcRestoreBackupResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +plc.ts:367 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/plc.PlcRestoreBackupResponse.md b/docs/classes/plc.PlcRestoreBackupResponse.md new file mode 100644 index 0000000..75b097f --- /dev/null +++ b/docs/classes/plc.PlcRestoreBackupResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / PlcRestoreBackupResponse + +# Class: PlcRestoreBackupResponse + +[plc](../modules/plc.md).PlcRestoreBackupResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`PlcRestoreBackupResponse`** + +## Table of contents + +### Constructors + +- [constructor](plc.PlcRestoreBackupResponse.md#constructor) + +### Properties + +- [error](plc.PlcRestoreBackupResponse.md#error) +- [id](plc.PlcRestoreBackupResponse.md#id) +- [kind](plc.PlcRestoreBackupResponse.md#kind) +- [result](plc.PlcRestoreBackupResponse.md#result) + +### Methods + +- [\_\_str\_\_](plc.PlcRestoreBackupResponse.md#__str__) +- [is\_error](plc.PlcRestoreBackupResponse.md#is_error) +- [parse](plc.PlcRestoreBackupResponse.md#parse) + +## Constructors + +### constructor + +• **new PlcRestoreBackupResponse**(): [`PlcRestoreBackupResponse`](plc.PlcRestoreBackupResponse.md) + +#### Returns + +[`PlcRestoreBackupResponse`](plc.PlcRestoreBackupResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +plc.ts:384 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `string` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +plc.ts:383 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/plc.PlcSetSystemTime.md b/docs/classes/plc.PlcSetSystemTime.md new file mode 100644 index 0000000..c59be45 --- /dev/null +++ b/docs/classes/plc.PlcSetSystemTime.md @@ -0,0 +1,383 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / PlcSetSystemTime + +# Class: PlcSetSystemTime + +[plc](../modules/plc.md).PlcSetSystemTime + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`PlcSetSystemTime`** + +## Table of contents + +### Constructors + +- [constructor](plc.PlcSetSystemTime.md#constructor) + +### Properties + +- [address](plc.PlcSetSystemTime.md#address) +- [method](plc.PlcSetSystemTime.md#method) +- [params](plc.PlcSetSystemTime.md#params) +- [plcCertificate](plc.PlcSetSystemTime.md#plccertificate) +- [protocol](plc.PlcSetSystemTime.md#protocol) +- [response](plc.PlcSetSystemTime.md#response) +- [token](plc.PlcSetSystemTime.md#token) +- [verifyTls](plc.PlcSetSystemTime.md#verifytls) + +### Methods + +- [\_\_str\_\_](plc.PlcSetSystemTime.md#__str__) +- [body](plc.PlcSetSystemTime.md#body) +- [execute](plc.PlcSetSystemTime.md#execute) +- [format\_response](plc.PlcSetSystemTime.md#format_response) +- [gethttpsAgent](plc.PlcSetSystemTime.md#gethttpsagent) +- [headers](plc.PlcSetSystemTime.md#headers) +- [parse](plc.PlcSetSystemTime.md#parse) +- [request](plc.PlcSetSystemTime.md#request) +- [url](plc.PlcSetSystemTime.md#url) + +## Constructors + +### constructor + +• **new PlcSetSystemTime**(`config`, `token`, `timestamp`): [`PlcSetSystemTime`](plc.PlcSetSystemTime.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `timestamp` | `string` | + +#### Returns + +[`PlcSetSystemTime`](plc.PlcSetSystemTime.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +plc.ts:130 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`PlcSetSystemTimeResponse`](plc.PlcSetSystemTimeResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`PlcSetSystemTimeResponse`](plc.PlcSetSystemTimeResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +plc.ts:137 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/plc.PlcSetSystemTimeResponse.md b/docs/classes/plc.PlcSetSystemTimeResponse.md new file mode 100644 index 0000000..065a7cb --- /dev/null +++ b/docs/classes/plc.PlcSetSystemTimeResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / PlcSetSystemTimeResponse + +# Class: PlcSetSystemTimeResponse + +[plc](../modules/plc.md).PlcSetSystemTimeResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`PlcSetSystemTimeResponse`** + +## Table of contents + +### Constructors + +- [constructor](plc.PlcSetSystemTimeResponse.md#constructor) + +### Properties + +- [error](plc.PlcSetSystemTimeResponse.md#error) +- [id](plc.PlcSetSystemTimeResponse.md#id) +- [kind](plc.PlcSetSystemTimeResponse.md#kind) +- [result](plc.PlcSetSystemTimeResponse.md#result) + +### Methods + +- [\_\_str\_\_](plc.PlcSetSystemTimeResponse.md#__str__) +- [is\_error](plc.PlcSetSystemTimeResponse.md#is_error) +- [parse](plc.PlcSetSystemTimeResponse.md#parse) + +## Constructors + +### constructor + +• **new PlcSetSystemTimeResponse**(): [`PlcSetSystemTimeResponse`](plc.PlcSetSystemTimeResponse.md) + +#### Returns + +[`PlcSetSystemTimeResponse`](plc.PlcSetSystemTimeResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +plc.ts:155 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +plc.ts:154 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/plc.PlcSetTimeSettings.md b/docs/classes/plc.PlcSetTimeSettings.md new file mode 100644 index 0000000..efff4c0 --- /dev/null +++ b/docs/classes/plc.PlcSetTimeSettings.md @@ -0,0 +1,383 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / PlcSetTimeSettings + +# Class: PlcSetTimeSettings + +[plc](../modules/plc.md).PlcSetTimeSettings + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`PlcSetTimeSettings`** + +## Table of contents + +### Constructors + +- [constructor](plc.PlcSetTimeSettings.md#constructor) + +### Properties + +- [address](plc.PlcSetTimeSettings.md#address) +- [method](plc.PlcSetTimeSettings.md#method) +- [params](plc.PlcSetTimeSettings.md#params) +- [plcCertificate](plc.PlcSetTimeSettings.md#plccertificate) +- [protocol](plc.PlcSetTimeSettings.md#protocol) +- [response](plc.PlcSetTimeSettings.md#response) +- [token](plc.PlcSetTimeSettings.md#token) +- [verifyTls](plc.PlcSetTimeSettings.md#verifytls) + +### Methods + +- [\_\_str\_\_](plc.PlcSetTimeSettings.md#__str__) +- [body](plc.PlcSetTimeSettings.md#body) +- [execute](plc.PlcSetTimeSettings.md#execute) +- [format\_response](plc.PlcSetTimeSettings.md#format_response) +- [gethttpsAgent](plc.PlcSetTimeSettings.md#gethttpsagent) +- [headers](plc.PlcSetTimeSettings.md#headers) +- [parse](plc.PlcSetTimeSettings.md#parse) +- [request](plc.PlcSetTimeSettings.md#request) +- [url](plc.PlcSetTimeSettings.md#url) + +## Constructors + +### constructor + +• **new PlcSetTimeSettings**(`config`, `token`, `TimeSettings`): [`PlcSetTimeSettings`](plc.PlcSetTimeSettings.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `TimeSettings` | [`TimeSettings`](plc.TimeSettings.md) | + +#### Returns + +[`PlcSetTimeSettings`](plc.PlcSetTimeSettings.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +plc.ts:264 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`PlcSetTimeSettingsResponse`](plc.PlcSetTimeSettingsResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`PlcSetTimeSettingsResponse`](plc.PlcSetTimeSettingsResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +plc.ts:313 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/plc.PlcSetTimeSettingsResponse.md b/docs/classes/plc.PlcSetTimeSettingsResponse.md new file mode 100644 index 0000000..f88d4a9 --- /dev/null +++ b/docs/classes/plc.PlcSetTimeSettingsResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / PlcSetTimeSettingsResponse + +# Class: PlcSetTimeSettingsResponse + +[plc](../modules/plc.md).PlcSetTimeSettingsResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`PlcSetTimeSettingsResponse`** + +## Table of contents + +### Constructors + +- [constructor](plc.PlcSetTimeSettingsResponse.md#constructor) + +### Properties + +- [error](plc.PlcSetTimeSettingsResponse.md#error) +- [id](plc.PlcSetTimeSettingsResponse.md#id) +- [kind](plc.PlcSetTimeSettingsResponse.md#kind) +- [result](plc.PlcSetTimeSettingsResponse.md#result) + +### Methods + +- [\_\_str\_\_](plc.PlcSetTimeSettingsResponse.md#__str__) +- [is\_error](plc.PlcSetTimeSettingsResponse.md#is_error) +- [parse](plc.PlcSetTimeSettingsResponse.md#parse) + +## Constructors + +### constructor + +• **new PlcSetTimeSettingsResponse**(): [`PlcSetTimeSettingsResponse`](plc.PlcSetTimeSettingsResponse.md) + +#### Returns + +[`PlcSetTimeSettingsResponse`](plc.PlcSetTimeSettingsResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +plc.ts:329 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +plc.ts:328 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/plc.Rule.md b/docs/classes/plc.Rule.md new file mode 100644 index 0000000..8476d47 --- /dev/null +++ b/docs/classes/plc.Rule.md @@ -0,0 +1,46 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / Rule + +# Class: Rule + +[plc](../modules/plc.md).Rule + +## Table of contents + +### Constructors + +- [constructor](plc.Rule.md#constructor) + +### Properties + +- [ruleDst](plc.Rule.md#ruledst) +- [ruleStd](plc.Rule.md#rulestd) + +## Constructors + +### constructor + +• **new Rule**(): [`Rule`](plc.Rule.md) + +#### Returns + +[`Rule`](plc.Rule.md) + +## Properties + +### ruleDst + +• **ruleDst**: [`RuleDst`](plc.RuleDst.md) + +#### Defined in + +plc.ts:177 + +___ + +### ruleStd + +• **ruleStd**: [`RuleStd`](plc.RuleStd.md) + +#### Defined in + +plc.ts:176 diff --git a/docs/classes/plc.RuleDst.md b/docs/classes/plc.RuleDst.md new file mode 100644 index 0000000..6403520 --- /dev/null +++ b/docs/classes/plc.RuleDst.md @@ -0,0 +1,46 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / RuleDst + +# Class: RuleDst + +[plc](../modules/plc.md).RuleDst + +## Table of contents + +### Constructors + +- [constructor](plc.RuleDst.md#constructor) + +### Properties + +- [offset](plc.RuleDst.md#offset) +- [start](plc.RuleDst.md#start) + +## Constructors + +### constructor + +• **new RuleDst**(): [`RuleDst`](plc.RuleDst.md) + +#### Returns + +[`RuleDst`](plc.RuleDst.md) + +## Properties + +### offset + +• **offset**: `string` = `""` + +#### Defined in + +plc.ts:173 + +___ + +### start + +• **start**: [`RuleStart`](plc.RuleStart.md) + +#### Defined in + +plc.ts:172 diff --git a/docs/classes/plc.RuleStart.md b/docs/classes/plc.RuleStart.md new file mode 100644 index 0000000..d8616a5 --- /dev/null +++ b/docs/classes/plc.RuleStart.md @@ -0,0 +1,79 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / RuleStart + +# Class: RuleStart + +[plc](../modules/plc.md).RuleStart + +## Table of contents + +### Constructors + +- [constructor](plc.RuleStart.md#constructor) + +### Properties + +- [day\_of\_week](plc.RuleStart.md#day_of_week) +- [hour](plc.RuleStart.md#hour) +- [minute](plc.RuleStart.md#minute) +- [month](plc.RuleStart.md#month) +- [week](plc.RuleStart.md#week) + +## Constructors + +### constructor + +• **new RuleStart**(): [`RuleStart`](plc.RuleStart.md) + +#### Returns + +[`RuleStart`](plc.RuleStart.md) + +## Properties + +### day\_of\_week + +• **day\_of\_week**: `string` = `""` + +#### Defined in + +plc.ts:163 + +___ + +### hour + +• **hour**: `Number` = `0` + +#### Defined in + +plc.ts:164 + +___ + +### minute + +• **minute**: `Number` = `0` + +#### Defined in + +plc.ts:165 + +___ + +### month + +• **month**: `Number` = `0` + +#### Defined in + +plc.ts:161 + +___ + +### week + +• **week**: `Number` = `0` + +#### Defined in + +plc.ts:162 diff --git a/docs/classes/plc.RuleStd.md b/docs/classes/plc.RuleStd.md new file mode 100644 index 0000000..7f6edf2 --- /dev/null +++ b/docs/classes/plc.RuleStd.md @@ -0,0 +1,35 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / RuleStd + +# Class: RuleStd + +[plc](../modules/plc.md).RuleStd + +## Table of contents + +### Constructors + +- [constructor](plc.RuleStd.md#constructor) + +### Properties + +- [start](plc.RuleStd.md#start) + +## Constructors + +### constructor + +• **new RuleStd**(): [`RuleStd`](plc.RuleStd.md) + +#### Returns + +[`RuleStd`](plc.RuleStd.md) + +## Properties + +### start + +• **start**: [`RuleStart`](plc.RuleStart.md) + +#### Defined in + +plc.ts:168 diff --git a/docs/classes/plc.TimeSettings.md b/docs/classes/plc.TimeSettings.md new file mode 100644 index 0000000..0963073 --- /dev/null +++ b/docs/classes/plc.TimeSettings.md @@ -0,0 +1,57 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / TimeSettings + +# Class: TimeSettings + +[plc](../modules/plc.md).TimeSettings + +## Table of contents + +### Constructors + +- [constructor](plc.TimeSettings.md#constructor) + +### Properties + +- [current\_offset](plc.TimeSettings.md#current_offset) +- [rule](plc.TimeSettings.md#rule) +- [utc\_offset](plc.TimeSettings.md#utc_offset) + +## Constructors + +### constructor + +• **new TimeSettings**(): [`TimeSettings`](plc.TimeSettings.md) + +#### Returns + +[`TimeSettings`](plc.TimeSettings.md) + +## Properties + +### current\_offset + +• **current\_offset**: `string` = `""` + +#### Defined in + +plc.ts:180 + +___ + +### rule + +• `Optional` **rule**: [`Rule`](plc.Rule.md) + +#### Defined in + +plc.ts:182 + +___ + +### utc\_offset + +• **utc\_offset**: `string` = `""` + +#### Defined in + +plc.ts:181 diff --git a/docs/classes/plcprogram.PlcProgramBrowse.md b/docs/classes/plcprogram.PlcProgramBrowse.md new file mode 100644 index 0000000..c0816ec --- /dev/null +++ b/docs/classes/plcprogram.PlcProgramBrowse.md @@ -0,0 +1,385 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plcprogram](../modules/plcprogram.md) / PlcProgramBrowse + +# Class: PlcProgramBrowse + +[plcprogram](../modules/plcprogram.md).PlcProgramBrowse + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`PlcProgramBrowse`** + +## Table of contents + +### Constructors + +- [constructor](plcprogram.PlcProgramBrowse.md#constructor) + +### Properties + +- [address](plcprogram.PlcProgramBrowse.md#address) +- [method](plcprogram.PlcProgramBrowse.md#method) +- [params](plcprogram.PlcProgramBrowse.md#params) +- [plcCertificate](plcprogram.PlcProgramBrowse.md#plccertificate) +- [protocol](plcprogram.PlcProgramBrowse.md#protocol) +- [response](plcprogram.PlcProgramBrowse.md#response) +- [token](plcprogram.PlcProgramBrowse.md#token) +- [verifyTls](plcprogram.PlcProgramBrowse.md#verifytls) + +### Methods + +- [\_\_str\_\_](plcprogram.PlcProgramBrowse.md#__str__) +- [body](plcprogram.PlcProgramBrowse.md#body) +- [execute](plcprogram.PlcProgramBrowse.md#execute) +- [format\_response](plcprogram.PlcProgramBrowse.md#format_response) +- [gethttpsAgent](plcprogram.PlcProgramBrowse.md#gethttpsagent) +- [headers](plcprogram.PlcProgramBrowse.md#headers) +- [parse](plcprogram.PlcProgramBrowse.md#parse) +- [request](plcprogram.PlcProgramBrowse.md#request) +- [url](plcprogram.PlcProgramBrowse.md#url) + +## Constructors + +### constructor + +• **new PlcProgramBrowse**(`config`, `token`, `mode`, `Var?`, `type?`): [`PlcProgramBrowse`](plcprogram.PlcProgramBrowse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `mode` | `string` | +| `Var?` | `string` | +| `type?` | `string`[] | + +#### Returns + +[`PlcProgramBrowse`](plcprogram.PlcProgramBrowse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +plcprogram.ts:26 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`PlcProgramBrowseResponse`](plcprogram.PlcProgramBrowseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`PlcProgramBrowseResponse`](plcprogram.PlcProgramBrowseResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +plcprogram.ts:44 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/plcprogram.PlcProgramBrowseArrayData.md b/docs/classes/plcprogram.PlcProgramBrowseArrayData.md new file mode 100644 index 0000000..a2290b3 --- /dev/null +++ b/docs/classes/plcprogram.PlcProgramBrowseArrayData.md @@ -0,0 +1,46 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plcprogram](../modules/plcprogram.md) / PlcProgramBrowseArrayData + +# Class: PlcProgramBrowseArrayData + +[plcprogram](../modules/plcprogram.md).PlcProgramBrowseArrayData + +## Table of contents + +### Constructors + +- [constructor](plcprogram.PlcProgramBrowseArrayData.md#constructor) + +### Properties + +- [count](plcprogram.PlcProgramBrowseArrayData.md#count) +- [start\_index](plcprogram.PlcProgramBrowseArrayData.md#start_index) + +## Constructors + +### constructor + +• **new PlcProgramBrowseArrayData**(): [`PlcProgramBrowseArrayData`](plcprogram.PlcProgramBrowseArrayData.md) + +#### Returns + +[`PlcProgramBrowseArrayData`](plcprogram.PlcProgramBrowseArrayData.md) + +## Properties + +### count + +• **count**: `number` = `0` + +#### Defined in + +plcprogram.ts:6 + +___ + +### start\_index + +• **start\_index**: `number` = `0` + +#### Defined in + +plcprogram.ts:5 diff --git a/docs/classes/plcprogram.PlcProgramBrowseResponse.md b/docs/classes/plcprogram.PlcProgramBrowseResponse.md new file mode 100644 index 0000000..ace3c26 --- /dev/null +++ b/docs/classes/plcprogram.PlcProgramBrowseResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plcprogram](../modules/plcprogram.md) / PlcProgramBrowseResponse + +# Class: PlcProgramBrowseResponse + +[plcprogram](../modules/plcprogram.md).PlcProgramBrowseResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`PlcProgramBrowseResponse`** + +## Table of contents + +### Constructors + +- [constructor](plcprogram.PlcProgramBrowseResponse.md#constructor) + +### Properties + +- [error](plcprogram.PlcProgramBrowseResponse.md#error) +- [id](plcprogram.PlcProgramBrowseResponse.md#id) +- [kind](plcprogram.PlcProgramBrowseResponse.md#kind) +- [result](plcprogram.PlcProgramBrowseResponse.md#result) + +### Methods + +- [\_\_str\_\_](plcprogram.PlcProgramBrowseResponse.md#__str__) +- [is\_error](plcprogram.PlcProgramBrowseResponse.md#is_error) +- [parse](plcprogram.PlcProgramBrowseResponse.md#parse) + +## Constructors + +### constructor + +• **new PlcProgramBrowseResponse**(): [`PlcProgramBrowseResponse`](plcprogram.PlcProgramBrowseResponse.md) + +#### Returns + +[`PlcProgramBrowseResponse`](plcprogram.PlcProgramBrowseResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +plcprogram.ts:93 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: [`PlcProgramBrowseVariable`](plcprogram.PlcProgramBrowseVariable.md)[] + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +plcprogram.ts:92 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/plcprogram.PlcProgramBrowseVariable.md b/docs/classes/plcprogram.PlcProgramBrowseVariable.md new file mode 100644 index 0000000..3840e4a --- /dev/null +++ b/docs/classes/plcprogram.PlcProgramBrowseVariable.md @@ -0,0 +1,145 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plcprogram](../modules/plcprogram.md) / PlcProgramBrowseVariable + +# Class: PlcProgramBrowseVariable + +[plcprogram](../modules/plcprogram.md).PlcProgramBrowseVariable + +## Table of contents + +### Constructors + +- [constructor](plcprogram.PlcProgramBrowseVariable.md#constructor) + +### Properties + +- [address](plcprogram.PlcProgramBrowseVariable.md#address) +- [area](plcprogram.PlcProgramBrowseVariable.md#area) +- [array\_dimensions](plcprogram.PlcProgramBrowseVariable.md#array_dimensions) +- [block\_number](plcprogram.PlcProgramBrowseVariable.md#block_number) +- [block\_type](plcprogram.PlcProgramBrowseVariable.md#block_type) +- [datatype](plcprogram.PlcProgramBrowseVariable.md#datatype) +- [db\_number](plcprogram.PlcProgramBrowseVariable.md#db_number) +- [has\_children](plcprogram.PlcProgramBrowseVariable.md#has_children) +- [max\_length](plcprogram.PlcProgramBrowseVariable.md#max_length) +- [name](plcprogram.PlcProgramBrowseVariable.md#name) +- [read\_only](plcprogram.PlcProgramBrowseVariable.md#read_only) + +## Constructors + +### constructor + +• **new PlcProgramBrowseVariable**(): [`PlcProgramBrowseVariable`](plcprogram.PlcProgramBrowseVariable.md) + +#### Returns + +[`PlcProgramBrowseVariable`](plcprogram.PlcProgramBrowseVariable.md) + +## Properties + +### address + +• `Optional` **address**: `string` + +#### Defined in + +plcprogram.ts:12 + +___ + +### area + +• `Optional` **area**: `string` + +#### Defined in + +plcprogram.ts:16 + +___ + +### array\_dimensions + +• `Optional` **array\_dimensions**: [`PlcProgramBrowseArrayData`](plcprogram.PlcProgramBrowseArrayData.md) + +#### Defined in + +plcprogram.ts:19 + +___ + +### block\_number + +• `Optional` **block\_number**: `number` + +#### Defined in + +plcprogram.ts:20 + +___ + +### block\_type + +• `Optional` **block\_type**: `string` + +#### Defined in + +plcprogram.ts:21 + +___ + +### datatype + +• **datatype**: `string` = `''` + +#### Defined in + +plcprogram.ts:17 + +___ + +### db\_number + +• `Optional` **db\_number**: `number` + +#### Defined in + +plcprogram.ts:15 + +___ + +### has\_children + +• `Optional` **has\_children**: `boolean` + +#### Defined in + +plcprogram.ts:14 + +___ + +### max\_length + +• `Optional` **max\_length**: `number` + +#### Defined in + +plcprogram.ts:18 + +___ + +### name + +• **name**: `string` = `''` + +#### Defined in + +plcprogram.ts:11 + +___ + +### read\_only + +• `Optional` **read\_only**: `boolean` + +#### Defined in + +plcprogram.ts:13 diff --git a/docs/classes/plcprogram.PlcProgramDownloadProfilingData.md b/docs/classes/plcprogram.PlcProgramDownloadProfilingData.md new file mode 100644 index 0000000..8656d01 --- /dev/null +++ b/docs/classes/plcprogram.PlcProgramDownloadProfilingData.md @@ -0,0 +1,382 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plcprogram](../modules/plcprogram.md) / PlcProgramDownloadProfilingData + +# Class: PlcProgramDownloadProfilingData + +[plcprogram](../modules/plcprogram.md).PlcProgramDownloadProfilingData + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`PlcProgramDownloadProfilingData`** + +## Table of contents + +### Constructors + +- [constructor](plcprogram.PlcProgramDownloadProfilingData.md#constructor) + +### Properties + +- [address](plcprogram.PlcProgramDownloadProfilingData.md#address) +- [method](plcprogram.PlcProgramDownloadProfilingData.md#method) +- [params](plcprogram.PlcProgramDownloadProfilingData.md#params) +- [plcCertificate](plcprogram.PlcProgramDownloadProfilingData.md#plccertificate) +- [protocol](plcprogram.PlcProgramDownloadProfilingData.md#protocol) +- [response](plcprogram.PlcProgramDownloadProfilingData.md#response) +- [token](plcprogram.PlcProgramDownloadProfilingData.md#token) +- [verifyTls](plcprogram.PlcProgramDownloadProfilingData.md#verifytls) + +### Methods + +- [\_\_str\_\_](plcprogram.PlcProgramDownloadProfilingData.md#__str__) +- [body](plcprogram.PlcProgramDownloadProfilingData.md#body) +- [execute](plcprogram.PlcProgramDownloadProfilingData.md#execute) +- [format\_response](plcprogram.PlcProgramDownloadProfilingData.md#format_response) +- [gethttpsAgent](plcprogram.PlcProgramDownloadProfilingData.md#gethttpsagent) +- [headers](plcprogram.PlcProgramDownloadProfilingData.md#headers) +- [parse](plcprogram.PlcProgramDownloadProfilingData.md#parse) +- [request](plcprogram.PlcProgramDownloadProfilingData.md#request) +- [url](plcprogram.PlcProgramDownloadProfilingData.md#url) + +## Constructors + +### constructor + +• **new PlcProgramDownloadProfilingData**(`config`, `token`): [`PlcProgramDownloadProfilingData`](plcprogram.PlcProgramDownloadProfilingData.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | + +#### Returns + +[`PlcProgramDownloadProfilingData`](plcprogram.PlcProgramDownloadProfilingData.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +plcprogram.ts:99 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`PlcProgramDownloadProfilingDataResponse`](plcprogram.PlcProgramDownloadProfilingDataResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`PlcProgramDownloadProfilingDataResponse`](plcprogram.PlcProgramDownloadProfilingDataResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +plcprogram.ts:104 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/plcprogram.PlcProgramDownloadProfilingDataResponse.md b/docs/classes/plcprogram.PlcProgramDownloadProfilingDataResponse.md new file mode 100644 index 0000000..59e3172 --- /dev/null +++ b/docs/classes/plcprogram.PlcProgramDownloadProfilingDataResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plcprogram](../modules/plcprogram.md) / PlcProgramDownloadProfilingDataResponse + +# Class: PlcProgramDownloadProfilingDataResponse + +[plcprogram](../modules/plcprogram.md).PlcProgramDownloadProfilingDataResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`PlcProgramDownloadProfilingDataResponse`** + +## Table of contents + +### Constructors + +- [constructor](plcprogram.PlcProgramDownloadProfilingDataResponse.md#constructor) + +### Properties + +- [error](plcprogram.PlcProgramDownloadProfilingDataResponse.md#error) +- [id](plcprogram.PlcProgramDownloadProfilingDataResponse.md#id) +- [kind](plcprogram.PlcProgramDownloadProfilingDataResponse.md#kind) +- [result](plcprogram.PlcProgramDownloadProfilingDataResponse.md#result) + +### Methods + +- [\_\_str\_\_](plcprogram.PlcProgramDownloadProfilingDataResponse.md#__str__) +- [is\_error](plcprogram.PlcProgramDownloadProfilingDataResponse.md#is_error) +- [parse](plcprogram.PlcProgramDownloadProfilingDataResponse.md#parse) + +## Constructors + +### constructor + +• **new PlcProgramDownloadProfilingDataResponse**(): [`PlcProgramDownloadProfilingDataResponse`](plcprogram.PlcProgramDownloadProfilingDataResponse.md) + +#### Returns + +[`PlcProgramDownloadProfilingDataResponse`](plcprogram.PlcProgramDownloadProfilingDataResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +plcprogram.ts:128 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `string` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +plcprogram.ts:127 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/plcprogram.PlcProgramRead.md b/docs/classes/plcprogram.PlcProgramRead.md new file mode 100644 index 0000000..728b35a --- /dev/null +++ b/docs/classes/plcprogram.PlcProgramRead.md @@ -0,0 +1,384 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plcprogram](../modules/plcprogram.md) / PlcProgramRead + +# Class: PlcProgramRead + +[plcprogram](../modules/plcprogram.md).PlcProgramRead + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`PlcProgramRead`** + +## Table of contents + +### Constructors + +- [constructor](plcprogram.PlcProgramRead.md#constructor) + +### Properties + +- [address](plcprogram.PlcProgramRead.md#address) +- [method](plcprogram.PlcProgramRead.md#method) +- [params](plcprogram.PlcProgramRead.md#params) +- [plcCertificate](plcprogram.PlcProgramRead.md#plccertificate) +- [protocol](plcprogram.PlcProgramRead.md#protocol) +- [response](plcprogram.PlcProgramRead.md#response) +- [token](plcprogram.PlcProgramRead.md#token) +- [verifyTls](plcprogram.PlcProgramRead.md#verifytls) + +### Methods + +- [\_\_str\_\_](plcprogram.PlcProgramRead.md#__str__) +- [body](plcprogram.PlcProgramRead.md#body) +- [execute](plcprogram.PlcProgramRead.md#execute) +- [format\_response](plcprogram.PlcProgramRead.md#format_response) +- [gethttpsAgent](plcprogram.PlcProgramRead.md#gethttpsagent) +- [headers](plcprogram.PlcProgramRead.md#headers) +- [parse](plcprogram.PlcProgramRead.md#parse) +- [request](plcprogram.PlcProgramRead.md#request) +- [url](plcprogram.PlcProgramRead.md#url) + +## Constructors + +### constructor + +• **new PlcProgramRead**(`config`, `token`, `Var`, `mode?`): [`PlcProgramRead`](plcprogram.PlcProgramRead.md) + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | `undefined` | +| `token` | `string` | `undefined` | +| `Var` | `string` | `undefined` | +| `mode` | `string` | `"simple"` | + +#### Returns + +[`PlcProgramRead`](plcprogram.PlcProgramRead.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +plcprogram.ts:133 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`PlcProgramReadResponse`](plcprogram.PlcProgramReadResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`PlcProgramReadResponse`](plcprogram.PlcProgramReadResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +plcprogram.ts:138 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/plcprogram.PlcProgramReadResponse.md b/docs/classes/plcprogram.PlcProgramReadResponse.md new file mode 100644 index 0000000..2f41765 --- /dev/null +++ b/docs/classes/plcprogram.PlcProgramReadResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plcprogram](../modules/plcprogram.md) / PlcProgramReadResponse + +# Class: PlcProgramReadResponse + +[plcprogram](../modules/plcprogram.md).PlcProgramReadResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`PlcProgramReadResponse`** + +## Table of contents + +### Constructors + +- [constructor](plcprogram.PlcProgramReadResponse.md#constructor) + +### Properties + +- [error](plcprogram.PlcProgramReadResponse.md#error) +- [id](plcprogram.PlcProgramReadResponse.md#id) +- [kind](plcprogram.PlcProgramReadResponse.md#kind) +- [result](plcprogram.PlcProgramReadResponse.md#result) + +### Methods + +- [\_\_str\_\_](plcprogram.PlcProgramReadResponse.md#__str__) +- [is\_error](plcprogram.PlcProgramReadResponse.md#is_error) +- [parse](plcprogram.PlcProgramReadResponse.md#parse) + +## Constructors + +### constructor + +• **new PlcProgramReadResponse**(): [`PlcProgramReadResponse`](plcprogram.PlcProgramReadResponse.md) + +#### Returns + +[`PlcProgramReadResponse`](plcprogram.PlcProgramReadResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +plcprogram.ts:156 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `any` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +plcprogram.ts:155 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/plcprogram.PlcProgramWrite.md b/docs/classes/plcprogram.PlcProgramWrite.md new file mode 100644 index 0000000..53c3601 --- /dev/null +++ b/docs/classes/plcprogram.PlcProgramWrite.md @@ -0,0 +1,385 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plcprogram](../modules/plcprogram.md) / PlcProgramWrite + +# Class: PlcProgramWrite + +[plcprogram](../modules/plcprogram.md).PlcProgramWrite + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`PlcProgramWrite`** + +## Table of contents + +### Constructors + +- [constructor](plcprogram.PlcProgramWrite.md#constructor) + +### Properties + +- [address](plcprogram.PlcProgramWrite.md#address) +- [method](plcprogram.PlcProgramWrite.md#method) +- [params](plcprogram.PlcProgramWrite.md#params) +- [plcCertificate](plcprogram.PlcProgramWrite.md#plccertificate) +- [protocol](plcprogram.PlcProgramWrite.md#protocol) +- [response](plcprogram.PlcProgramWrite.md#response) +- [token](plcprogram.PlcProgramWrite.md#token) +- [verifyTls](plcprogram.PlcProgramWrite.md#verifytls) + +### Methods + +- [\_\_str\_\_](plcprogram.PlcProgramWrite.md#__str__) +- [body](plcprogram.PlcProgramWrite.md#body) +- [execute](plcprogram.PlcProgramWrite.md#execute) +- [format\_response](plcprogram.PlcProgramWrite.md#format_response) +- [gethttpsAgent](plcprogram.PlcProgramWrite.md#gethttpsagent) +- [headers](plcprogram.PlcProgramWrite.md#headers) +- [parse](plcprogram.PlcProgramWrite.md#parse) +- [request](plcprogram.PlcProgramWrite.md#request) +- [url](plcprogram.PlcProgramWrite.md#url) + +## Constructors + +### constructor + +• **new PlcProgramWrite**(`config`, `token`, `Var`, `value`, `mode?`): [`PlcProgramWrite`](plcprogram.PlcProgramWrite.md) + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | `undefined` | +| `token` | `string` | `undefined` | +| `Var` | `string` | `undefined` | +| `value` | `any` | `undefined` | +| `mode` | `string` | `"simple"` | + +#### Returns + +[`PlcProgramWrite`](plcprogram.PlcProgramWrite.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +plcprogram.ts:162 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`PlcProgramWriteResponse`](plcprogram.PlcProgramWriteResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`PlcProgramWriteResponse`](plcprogram.PlcProgramWriteResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +plcprogram.ts:168 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/plcprogram.PlcProgramWriteResponse.md b/docs/classes/plcprogram.PlcProgramWriteResponse.md new file mode 100644 index 0000000..b78eee1 --- /dev/null +++ b/docs/classes/plcprogram.PlcProgramWriteResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plcprogram](../modules/plcprogram.md) / PlcProgramWriteResponse + +# Class: PlcProgramWriteResponse + +[plcprogram](../modules/plcprogram.md).PlcProgramWriteResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`PlcProgramWriteResponse`** + +## Table of contents + +### Constructors + +- [constructor](plcprogram.PlcProgramWriteResponse.md#constructor) + +### Properties + +- [error](plcprogram.PlcProgramWriteResponse.md#error) +- [id](plcprogram.PlcProgramWriteResponse.md#id) +- [kind](plcprogram.PlcProgramWriteResponse.md#kind) +- [result](plcprogram.PlcProgramWriteResponse.md#result) + +### Methods + +- [\_\_str\_\_](plcprogram.PlcProgramWriteResponse.md#__str__) +- [is\_error](plcprogram.PlcProgramWriteResponse.md#is_error) +- [parse](plcprogram.PlcProgramWriteResponse.md#parse) + +## Constructors + +### constructor + +• **new PlcProgramWriteResponse**(): [`PlcProgramWriteResponse`](plcprogram.PlcProgramWriteResponse.md) + +#### Returns + +[`PlcProgramWriteResponse`](plcprogram.PlcProgramWriteResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +plcprogram.ts:184 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +plcprogram.ts:183 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/project.Languages.md b/docs/classes/project.Languages.md new file mode 100644 index 0000000..a681c98 --- /dev/null +++ b/docs/classes/project.Languages.md @@ -0,0 +1,35 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [project](../modules/project.md) / Languages + +# Class: Languages + +[project](../modules/project.md).Languages + +## Table of contents + +### Constructors + +- [constructor](project.Languages.md#constructor) + +### Properties + +- [language](project.Languages.md#language) + +## Constructors + +### constructor + +• **new Languages**(): [`Languages`](project.Languages.md) + +#### Returns + +[`Languages`](project.Languages.md) + +## Properties + +### language + +• **language**: `string` = `''` + +#### Defined in + +project.ts:6 diff --git a/docs/classes/project.ProjectLanguages.md b/docs/classes/project.ProjectLanguages.md new file mode 100644 index 0000000..a7d0afe --- /dev/null +++ b/docs/classes/project.ProjectLanguages.md @@ -0,0 +1,382 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [project](../modules/project.md) / ProjectLanguages + +# Class: ProjectLanguages + +[project](../modules/project.md).ProjectLanguages + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`ProjectLanguages`** + +## Table of contents + +### Constructors + +- [constructor](project.ProjectLanguages.md#constructor) + +### Properties + +- [address](project.ProjectLanguages.md#address) +- [method](project.ProjectLanguages.md#method) +- [params](project.ProjectLanguages.md#params) +- [plcCertificate](project.ProjectLanguages.md#plccertificate) +- [protocol](project.ProjectLanguages.md#protocol) +- [response](project.ProjectLanguages.md#response) +- [token](project.ProjectLanguages.md#token) +- [verifyTls](project.ProjectLanguages.md#verifytls) + +### Methods + +- [\_\_str\_\_](project.ProjectLanguages.md#__str__) +- [body](project.ProjectLanguages.md#body) +- [execute](project.ProjectLanguages.md#execute) +- [format\_response](project.ProjectLanguages.md#format_response) +- [gethttpsAgent](project.ProjectLanguages.md#gethttpsagent) +- [headers](project.ProjectLanguages.md#headers) +- [parse](project.ProjectLanguages.md#parse) +- [request](project.ProjectLanguages.md#request) +- [url](project.ProjectLanguages.md#url) + +## Constructors + +### constructor + +• **new ProjectLanguages**(`config`, `token`): [`ProjectLanguages`](project.ProjectLanguages.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | + +#### Returns + +[`ProjectLanguages`](project.ProjectLanguages.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +project.ts:9 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`ProjectLanguagesResponse`](project.ProjectLanguagesResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`ProjectLanguagesResponse`](project.ProjectLanguagesResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +project.ts:13 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/project.ProjectLanguagesResponse.md b/docs/classes/project.ProjectLanguagesResponse.md new file mode 100644 index 0000000..f930fc4 --- /dev/null +++ b/docs/classes/project.ProjectLanguagesResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [project](../modules/project.md) / ProjectLanguagesResponse + +# Class: ProjectLanguagesResponse + +[project](../modules/project.md).ProjectLanguagesResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`ProjectLanguagesResponse`** + +## Table of contents + +### Constructors + +- [constructor](project.ProjectLanguagesResponse.md#constructor) + +### Properties + +- [error](project.ProjectLanguagesResponse.md#error) +- [id](project.ProjectLanguagesResponse.md#id) +- [kind](project.ProjectLanguagesResponse.md#kind) +- [result](project.ProjectLanguagesResponse.md#result) + +### Methods + +- [\_\_str\_\_](project.ProjectLanguagesResponse.md#__str__) +- [is\_error](project.ProjectLanguagesResponse.md#is_error) +- [parse](project.ProjectLanguagesResponse.md#parse) + +## Constructors + +### constructor + +• **new ProjectLanguagesResponse**(): [`ProjectLanguagesResponse`](project.ProjectLanguagesResponse.md) + +#### Returns + +[`ProjectLanguagesResponse`](project.ProjectLanguagesResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +project.ts:53 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: [`Languages`](project.Languages.md)[] + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +project.ts:52 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/request.JsonrpcBaseRequest.md b/docs/classes/request.JsonrpcBaseRequest.md new file mode 100644 index 0000000..dfc2733 --- /dev/null +++ b/docs/classes/request.JsonrpcBaseRequest.md @@ -0,0 +1,446 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [request](../modules/request.md) / JsonrpcBaseRequest + +# Class: JsonrpcBaseRequest + +[request](../modules/request.md).JsonrpcBaseRequest + +## Hierarchy + +- **`JsonrpcBaseRequest`** + + ↳ [`AlarmsBrowse`](alarms.AlarmsBrowse.md) + + ↳ [`AlarmsAcknowledge`](alarms.AlarmsAcknowledge.md) + + ↳ [`ApiLogin`](api.ApiLogin.md) + + ↳ [`ApiPing`](api.ApiPing.md) + + ↳ [`ApiBrowse`](api.ApiBrowse.md) + + ↳ [`ApiGetPermissions`](api.ApiGetPermissions.md) + + ↳ [`ApiLogout`](api.ApiLogout.md) + + ↳ [`ApiGetCertificateUrl`](api.ApiGetCertificateUrl.md) + + ↳ [`ApiVersion`](api.ApiVersion.md) + + ↳ [`ApiCloseTickets`](api.ApiCloseTickets.md) + + ↳ [`ApiBrowseTickets`](api.ApiBrowseTickets.md) + + ↳ [`ApiGetQuantityStructures`](api.ApiGetQuantityStructures.md) + + ↳ [`ApiChangePassword`](api.ApiChangePassword.md) + + ↳ [`ApiGetPasswordPolicy`](api.ApiGetPasswordPolicy.md) + + ↳ [`ApiGetAuthenticationMode`](api.ApiGetAuthenticationMode.md) + + ↳ [`DataLogsDownloadAndClear`](datalogs.DataLogsDownloadAndClear.md) + + ↳ [`DiagnosticBufferBrowse`](diagnosticbuffer.DiagnosticBufferBrowse.md) + + ↳ [`FailsafeReadRuntimeGroups`](failsafe.FailsafeReadRuntimeGroups.md) + + ↳ [`FailsafeReadParameters`](failsafe.FailsafeReadParameters.md) + + ↳ [`FilesDownload`](files.FilesDownload.md) + + ↳ [`FilesCreate`](files.FilesCreate.md) + + ↳ [`FilesDelete`](files.FilesDelete.md) + + ↳ [`FilesCreateDirectory`](files.FilesCreateDirectory.md) + + ↳ [`FilesDeleteDirectory`](files.FilesDeleteDirectory.md) + + ↳ [`FilesRename`](files.FilesRename.md) + + ↳ [`FilesBrowse`](files.FilesBrowse.md) + + ↳ [`PlcReadOperatingMode`](plc.PlcReadOperatingMode.md) + + ↳ [`PlcRequestChangeOperatingMode`](plc.PlcRequestChangeOperatingMode.md) + + ↳ [`PlcReadSystemTime`](plc.PlcReadSystemTime.md) + + ↳ [`PlcSetSystemTime`](plc.PlcSetSystemTime.md) + + ↳ [`PlcReadTimeSettings`](plc.PlcReadTimeSettings.md) + + ↳ [`PlcSetTimeSettings`](plc.PlcSetTimeSettings.md) + + ↳ [`PlcCreateBackup`](plc.PlcCreateBackup.md) + + ↳ [`PlcRestoreBackup`](plc.PlcRestoreBackup.md) + + ↳ [`PlcProgramBrowse`](plcprogram.PlcProgramBrowse.md) + + ↳ [`PlcProgramDownloadProfilingData`](plcprogram.PlcProgramDownloadProfilingData.md) + + ↳ [`PlcProgramRead`](plcprogram.PlcProgramRead.md) + + ↳ [`PlcProgramWrite`](plcprogram.PlcProgramWrite.md) + + ↳ [`ProjectLanguages`](project.ProjectLanguages.md) + + ↳ [`SyslogBrowse`](syslog.SyslogBrowse.md) + + ↳ [`TicketDownloadData`](ticket.TicketDownloadData.md) + + ↳ [`WebAppCreate`](webApp.WebAppCreate.md) + + ↳ [`WebAppDelete`](webApp.WebAppDelete.md) + + ↳ [`WebAppRename`](webApp.WebAppRename.md) + + ↳ [`WebAppRenameResource`](webApp.WebAppRenameResource.md) + + ↳ [`WebAppSetState`](webApp.WebAppSetState.md) + + ↳ [`WebAppSetDefaultPage`](webApp.WebAppSetDefaultPage.md) + + ↳ [`WebAppSetNotFoundPage`](webApp.WebAppSetNotFoundPage.md) + + ↳ [`WebAppSetNotAuthorizedPage`](webApp.WebAppSetNotAuthorizedPage.md) + + ↳ [`WebAppCreateResource`](webApp.WebAppCreateResource.md) + + ↳ [`WebAppDeleteResource`](webApp.WebAppDeleteResource.md) + + ↳ [`WebAppDownloadResource`](webApp.WebAppDownloadResource.md) + + ↳ [`WebAppSetResourceETag`](webApp.WebAppSetResourceETag.md) + + ↳ [`WebAppSetResourceMediaType`](webApp.WebAppSetResourceMediaType.md) + + ↳ [`WebAppSetResourceModificationTime`](webApp.WebAppSetResourceModificationTime.md) + + ↳ [`WebAppSetResourceVisibility`](webApp.WebAppSetResourceVisibility.md) + + ↳ [`WebAppBrowse`](webApp.WebAppBrowse.md) + + ↳ [`WebAppBrowseResources`](webApp.WebAppBrowseResources.md) + + ↳ [`WebServerSetDefaultPage`](webserver.WebServerSetDefaultPage.md) + + ↳ [`WebServerReadDefaultPage`](webserver.WebServerReadDefaultPage.md) + +## Table of contents + +### Constructors + +- [constructor](request.JsonrpcBaseRequest.md#constructor) + +### Properties + +- [address](request.JsonrpcBaseRequest.md#address) +- [method](request.JsonrpcBaseRequest.md#method) +- [params](request.JsonrpcBaseRequest.md#params) +- [plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) +- [protocol](request.JsonrpcBaseRequest.md#protocol) +- [reqID](request.JsonrpcBaseRequest.md#reqid) +- [response](request.JsonrpcBaseRequest.md#response) +- [token](request.JsonrpcBaseRequest.md#token) +- [verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +### Methods + +- [\_\_str\_\_](request.JsonrpcBaseRequest.md#__str__) +- [body](request.JsonrpcBaseRequest.md#body) +- [execute](request.JsonrpcBaseRequest.md#execute) +- [format\_response](request.JsonrpcBaseRequest.md#format_response) +- [gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) +- [headers](request.JsonrpcBaseRequest.md#headers) +- [parse](request.JsonrpcBaseRequest.md#parse) +- [request](request.JsonrpcBaseRequest.md#request) +- [url](request.JsonrpcBaseRequest.md#url) + +## Constructors + +### constructor + +• **new JsonrpcBaseRequest**(`address`, `protocol`, `verifyTls`, `method?`, `params?`, `token?`, `reqID?`, `response?`, `plcCertificate?`): [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `address` | `string` | +| `protocol` | `string` | +| `verifyTls` | `boolean` | +| `method?` | `string` | +| `params?` | `Record`\<`string`, `any`\> | +| `token?` | `string` | +| `reqID?` | `number` | +| `response?` | `AxiosResponse`\<`any`, `any`\> | +| `plcCertificate?` | `Buffer` | + +#### Returns + +[`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + +#### Defined in + +request.ts:72 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Defined in + +request.ts:64 + +___ + +### reqID + +• `Private` `Optional` **reqID**: `number` + +#### Defined in + +request.ts:69 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Defined in + +request.ts:206 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Defined in + +request.ts:133 diff --git a/docs/classes/request.RequestConfig.md b/docs/classes/request.RequestConfig.md new file mode 100644 index 0000000..b4d758a --- /dev/null +++ b/docs/classes/request.RequestConfig.md @@ -0,0 +1,90 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [request](../modules/request.md) / RequestConfig + +# Class: RequestConfig + +[request](../modules/request.md).RequestConfig + +## Table of contents + +### Constructors + +- [constructor](request.RequestConfig.md#constructor) + +### Properties + +- [address](request.RequestConfig.md#address) +- [plcCertificate](request.RequestConfig.md#plccertificate) +- [protocol](request.RequestConfig.md#protocol) +- [verifyTls](request.RequestConfig.md#verifytls) + +## Constructors + +### constructor + +• **new RequestConfig**(): [`RequestConfig`](request.RequestConfig.md) + +#### Returns + +[`RequestConfig`](request.RequestConfig.md) + +## Properties + +### address + +• **address**: `string` = `''` + +Base configuration for all requests + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: Identifies the certificate from the PLC in the local system to be able to access the PLC. + +#### Defined in + +request.ts:26 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Defined in + +request.ts:29 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Defined in + +request.ts:27 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Defined in + +request.ts:28 diff --git a/docs/classes/response.JsonrpcBaseResponse.md b/docs/classes/response.JsonrpcBaseResponse.md new file mode 100644 index 0000000..d3cc7f7 --- /dev/null +++ b/docs/classes/response.JsonrpcBaseResponse.md @@ -0,0 +1,267 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [response](../modules/response.md) / JsonrpcBaseResponse + +# Class: JsonrpcBaseResponse + +[response](../modules/response.md).JsonrpcBaseResponse + +## Hierarchy + +- **`JsonrpcBaseResponse`** + + ↳ [`AlarmsBrowseResponse`](alarms.AlarmsBrowseResponse.md) + + ↳ [`AlarmsAcknowledgeResponse`](alarms.AlarmsAcknowledgeResponse.md) + + ↳ [`ApiLoginResponse`](api.ApiLoginResponse.md) + + ↳ [`ApiPingResponse`](api.ApiPingResponse.md) + + ↳ [`ApiBrowseResponse`](api.ApiBrowseResponse.md) + + ↳ [`ApiGetPermissionsResponse`](api.ApiGetPermissionsResponse.md) + + ↳ [`ApiLogoutResponse`](api.ApiLogoutResponse.md) + + ↳ [`ApiGetCertificateUrlResponse`](api.ApiGetCertificateUrlResponse.md) + + ↳ [`ApiVersionResponse`](api.ApiVersionResponse.md) + + ↳ [`ApiCloseTicketsResponse`](api.ApiCloseTicketsResponse.md) + + ↳ [`ApiBrowseTicketsResponse`](api.ApiBrowseTicketsResponse.md) + + ↳ [`ApiGetQuantityStructuresResponse`](api.ApiGetQuantityStructuresResponse.md) + + ↳ [`ApiChangePasswordResponse`](api.ApiChangePasswordResponse.md) + + ↳ [`ApiGetPasswordPolicyResponse`](api.ApiGetPasswordPolicyResponse.md) + + ↳ [`ApiGetAuthenticationModeResponse`](api.ApiGetAuthenticationModeResponse.md) + + ↳ [`DataLogsDownloadAndClearResponse`](datalogs.DataLogsDownloadAndClearResponse.md) + + ↳ [`DiagnosticBufferBrowseResponse`](diagnosticbuffer.DiagnosticBufferBrowseResponse.md) + + ↳ [`FailsafeReadRuntimeGroupsResponse`](failsafe.FailsafeReadRuntimeGroupsResponse.md) + + ↳ [`FailsafeReadParametersResponse`](failsafe.FailsafeReadParametersResponse.md) + + ↳ [`FilesDownloadResponse`](files.FilesDownloadResponse.md) + + ↳ [`FilesCreateResponse`](files.FilesCreateResponse.md) + + ↳ [`FilesDeleteResponse`](files.FilesDeleteResponse.md) + + ↳ [`FilesCreateDirectoryResponse`](files.FilesCreateDirectoryResponse.md) + + ↳ [`FilesDeleteDirectoryResponse`](files.FilesDeleteDirectoryResponse.md) + + ↳ [`FilesRenameResponse`](files.FilesRenameResponse.md) + + ↳ [`FilesBrowseResponse`](files.FilesBrowseResponse.md) + + ↳ [`PlcReadOperatingModeResponse`](plc.PlcReadOperatingModeResponse.md) + + ↳ [`PlcRequestChangeOperatingModeResponse`](plc.PlcRequestChangeOperatingModeResponse.md) + + ↳ [`PlcReadSystemTimeResponse`](plc.PlcReadSystemTimeResponse.md) + + ↳ [`PlcSetSystemTimeResponse`](plc.PlcSetSystemTimeResponse.md) + + ↳ [`PlcReadTimeSettingsResponse`](plc.PlcReadTimeSettingsResponse.md) + + ↳ [`PlcSetTimeSettingsResponse`](plc.PlcSetTimeSettingsResponse.md) + + ↳ [`PlcCreateBackupResponse`](plc.PlcCreateBackupResponse.md) + + ↳ [`PlcRestoreBackupResponse`](plc.PlcRestoreBackupResponse.md) + + ↳ [`PlcProgramBrowseResponse`](plcprogram.PlcProgramBrowseResponse.md) + + ↳ [`PlcProgramDownloadProfilingDataResponse`](plcprogram.PlcProgramDownloadProfilingDataResponse.md) + + ↳ [`PlcProgramReadResponse`](plcprogram.PlcProgramReadResponse.md) + + ↳ [`PlcProgramWriteResponse`](plcprogram.PlcProgramWriteResponse.md) + + ↳ [`ProjectLanguagesResponse`](project.ProjectLanguagesResponse.md) + + ↳ [`SyslogBrowseResponse`](syslog.SyslogBrowseResponse.md) + + ↳ [`WebAppCreateResponse`](webApp.WebAppCreateResponse.md) + + ↳ [`WebAppDeleteResponse`](webApp.WebAppDeleteResponse.md) + + ↳ [`WebAppRenameResponse`](webApp.WebAppRenameResponse.md) + + ↳ [`WebAppRenameResourceResponse`](webApp.WebAppRenameResourceResponse.md) + + ↳ [`WebAppSetStateResponse`](webApp.WebAppSetStateResponse.md) + + ↳ [`WebAppSetDefaultPageResponse`](webApp.WebAppSetDefaultPageResponse.md) + + ↳ [`WebAppSetNotFoundPageResponse`](webApp.WebAppSetNotFoundPageResponse.md) + + ↳ [`WebAppSetNotAuthorizedPageResponse`](webApp.WebAppSetNotAuthorizedPageResponse.md) + + ↳ [`WebAppCreateResourceResponse`](webApp.WebAppCreateResourceResponse.md) + + ↳ [`WebAppDeleteResourceResponse`](webApp.WebAppDeleteResourceResponse.md) + + ↳ [`WebAppDownloadResourceResponse`](webApp.WebAppDownloadResourceResponse.md) + + ↳ [`WebAppSetResourceETagResponse`](webApp.WebAppSetResourceETagResponse.md) + + ↳ [`WebAppSetResourceMediaTypeResponse`](webApp.WebAppSetResourceMediaTypeResponse.md) + + ↳ [`WebAppSetResourceModificationTimeResponse`](webApp.WebAppSetResourceModificationTimeResponse.md) + + ↳ [`WebAppSetResourceVisibilityResponse`](webApp.WebAppSetResourceVisibilityResponse.md) + + ↳ [`WebAppBrowseResponse`](webApp.WebAppBrowseResponse.md) + + ↳ [`WebAppBrowseResourcesResponse`](webApp.WebAppBrowseResourcesResponse.md) + + ↳ [`WebServerSetDefaultPageResponse`](webserver.WebServerSetDefaultPageResponse.md) + + ↳ [`WebServerReadDefaultPageResponse`](webserver.WebServerReadDefaultPageResponse.md) + +## Table of contents + +### Constructors + +- [constructor](response.JsonrpcBaseResponse.md#constructor) + +### Properties + +- [error](response.JsonrpcBaseResponse.md#error) +- [id](response.JsonrpcBaseResponse.md#id) +- [kind](response.JsonrpcBaseResponse.md#kind) +- [result](response.JsonrpcBaseResponse.md#result) + +### Methods + +- [\_\_str\_\_](response.JsonrpcBaseResponse.md#__str__) +- [is\_error](response.JsonrpcBaseResponse.md#is_error) +- [parse](response.JsonrpcBaseResponse.md#parse) + +## Constructors + +### constructor + +• **new JsonrpcBaseResponse**(`kind?`, `id?`, `error?`, `result?`): [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `kind?` | `string` | +| `id?` | `number` | +| `error?` | [`JsonrpcError`](response.JsonrpcError.md) | +| `result?` | `Record`\<`string`, `any`\> | + +#### Returns + +[`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Defined in + +response.ts:61 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `any` + +#### Defined in + +response.ts:56 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/response.JsonrpcError.md b/docs/classes/response.JsonrpcError.md new file mode 100644 index 0000000..3a22b88 --- /dev/null +++ b/docs/classes/response.JsonrpcError.md @@ -0,0 +1,101 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [response](../modules/response.md) / JsonrpcError + +# Class: JsonrpcError + +[response](../modules/response.md).JsonrpcError + +## Table of contents + +### Constructors + +- [constructor](response.JsonrpcError.md#constructor) + +### Properties + +- [code](response.JsonrpcError.md#code) +- [http\_code](response.JsonrpcError.md#http_code) +- [message](response.JsonrpcError.md#message) + +### Methods + +- [toString](response.JsonrpcError.md#tostring) + +## Constructors + +### constructor + +• **new JsonrpcError**(`http_code`, `code?`, `message?`): [`JsonrpcError`](response.JsonrpcError.md) + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `http_code` | `number` | `undefined` | +| `code` | `number` | `-1` | +| `message?` | `string` | `undefined` | + +#### Returns + +[`JsonrpcError`](response.JsonrpcError.md) + +#### Defined in + +response.ts:20 + +## Properties + +### code + +• **code**: `number` + +Base type for all errors returned by the SIMATIC S7 Webserver + +**`Param`** + +Code of the error, defined in webserver documentation + +**`Param`** + +Optional additional information provided by the Webserver + +**`Param`** + +HTTP Response code provided by the server response + +#### Defined in + +response.ts:16 + +___ + +### http\_code + +• **http\_code**: `number` + +#### Defined in + +response.ts:18 + +___ + +### message + +• `Optional` **message**: `string` + +#### Defined in + +response.ts:17 + +## Methods + +### toString + +▸ **toString**(): `string` + +#### Returns + +`string` + +#### Defined in + +response.ts:34 diff --git a/docs/classes/syslog.SyslogBrowse.md b/docs/classes/syslog.SyslogBrowse.md new file mode 100644 index 0000000..c1be527 --- /dev/null +++ b/docs/classes/syslog.SyslogBrowse.md @@ -0,0 +1,385 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [syslog](../modules/syslog.md) / SyslogBrowse + +# Class: SyslogBrowse + +[syslog](../modules/syslog.md).SyslogBrowse + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`SyslogBrowse`** + +## Table of contents + +### Constructors + +- [constructor](syslog.SyslogBrowse.md#constructor) + +### Properties + +- [address](syslog.SyslogBrowse.md#address) +- [method](syslog.SyslogBrowse.md#method) +- [params](syslog.SyslogBrowse.md#params) +- [plcCertificate](syslog.SyslogBrowse.md#plccertificate) +- [protocol](syslog.SyslogBrowse.md#protocol) +- [response](syslog.SyslogBrowse.md#response) +- [token](syslog.SyslogBrowse.md#token) +- [verifyTls](syslog.SyslogBrowse.md#verifytls) + +### Methods + +- [\_\_str\_\_](syslog.SyslogBrowse.md#__str__) +- [body](syslog.SyslogBrowse.md#body) +- [execute](syslog.SyslogBrowse.md#execute) +- [format\_response](syslog.SyslogBrowse.md#format_response) +- [gethttpsAgent](syslog.SyslogBrowse.md#gethttpsagent) +- [headers](syslog.SyslogBrowse.md#headers) +- [parse](syslog.SyslogBrowse.md#parse) +- [request](syslog.SyslogBrowse.md#request) +- [url](syslog.SyslogBrowse.md#url) + +## Constructors + +### constructor + +• **new SyslogBrowse**(`config`, `token`, `redundancy_id?`, `count?`, `first?`): [`SyslogBrowse`](syslog.SyslogBrowse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `redundancy_id?` | `number` | +| `count?` | `number` | +| `first?` | `number` | + +#### Returns + +[`SyslogBrowse`](syslog.SyslogBrowse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +syslog.ts:14 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`SyslogBrowseResponse`](syslog.SyslogBrowseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`SyslogBrowseResponse`](syslog.SyslogBrowseResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +syslog.ts:29 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/syslog.SyslogBrowseResponse.md b/docs/classes/syslog.SyslogBrowseResponse.md new file mode 100644 index 0000000..98f0485 --- /dev/null +++ b/docs/classes/syslog.SyslogBrowseResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [syslog](../modules/syslog.md) / SyslogBrowseResponse + +# Class: SyslogBrowseResponse + +[syslog](../modules/syslog.md).SyslogBrowseResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`SyslogBrowseResponse`** + +## Table of contents + +### Constructors + +- [constructor](syslog.SyslogBrowseResponse.md#constructor) + +### Properties + +- [error](syslog.SyslogBrowseResponse.md#error) +- [id](syslog.SyslogBrowseResponse.md#id) +- [kind](syslog.SyslogBrowseResponse.md#kind) +- [result](syslog.SyslogBrowseResponse.md#result) + +### Methods + +- [\_\_str\_\_](syslog.SyslogBrowseResponse.md#__str__) +- [is\_error](syslog.SyslogBrowseResponse.md#is_error) +- [parse](syslog.SyslogBrowseResponse.md#parse) + +## Constructors + +### constructor + +• **new SyslogBrowseResponse**(): [`SyslogBrowseResponse`](syslog.SyslogBrowseResponse.md) + +#### Returns + +[`SyslogBrowseResponse`](syslog.SyslogBrowseResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +syslog.ts:80 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: [`SyslogBrowseStructure`](syslog.SyslogBrowseStructure.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +syslog.ts:79 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/syslog.SyslogBrowseStructure.md b/docs/classes/syslog.SyslogBrowseStructure.md new file mode 100644 index 0000000..30932b8 --- /dev/null +++ b/docs/classes/syslog.SyslogBrowseStructure.md @@ -0,0 +1,57 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [syslog](../modules/syslog.md) / SyslogBrowseStructure + +# Class: SyslogBrowseStructure + +[syslog](../modules/syslog.md).SyslogBrowseStructure + +## Table of contents + +### Constructors + +- [constructor](syslog.SyslogBrowseStructure.md#constructor) + +### Properties + +- [count\_lost](syslog.SyslogBrowseStructure.md#count_lost) +- [count\_total](syslog.SyslogBrowseStructure.md#count_total) +- [entries](syslog.SyslogBrowseStructure.md#entries) + +## Constructors + +### constructor + +• **new SyslogBrowseStructure**(): [`SyslogBrowseStructure`](syslog.SyslogBrowseStructure.md) + +#### Returns + +[`SyslogBrowseStructure`](syslog.SyslogBrowseStructure.md) + +## Properties + +### count\_lost + +• **count\_lost**: `number` = `0` + +#### Defined in + +syslog.ts:11 + +___ + +### count\_total + +• **count\_total**: `number` = `0` + +#### Defined in + +syslog.ts:10 + +___ + +### entries + +• **entries**: [`SyslogData`](syslog.SyslogData.md)[] = `[]` + +#### Defined in + +syslog.ts:9 diff --git a/docs/classes/syslog.SyslogData.md b/docs/classes/syslog.SyslogData.md new file mode 100644 index 0000000..9dc959f --- /dev/null +++ b/docs/classes/syslog.SyslogData.md @@ -0,0 +1,35 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [syslog](../modules/syslog.md) / SyslogData + +# Class: SyslogData + +[syslog](../modules/syslog.md).SyslogData + +## Table of contents + +### Constructors + +- [constructor](syslog.SyslogData.md#constructor) + +### Properties + +- [raw](syslog.SyslogData.md#raw) + +## Constructors + +### constructor + +• **new SyslogData**(): [`SyslogData`](syslog.SyslogData.md) + +#### Returns + +[`SyslogData`](syslog.SyslogData.md) + +## Properties + +### raw + +• **raw**: `string` = `''` + +#### Defined in + +syslog.ts:6 diff --git a/docs/classes/ticket.ProxyTicketDownloadData.md b/docs/classes/ticket.ProxyTicketDownloadData.md new file mode 100644 index 0000000..b1c6c6b --- /dev/null +++ b/docs/classes/ticket.ProxyTicketDownloadData.md @@ -0,0 +1,395 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [ticket](../modules/ticket.md) / ProxyTicketDownloadData + +# Class: ProxyTicketDownloadData + +[ticket](../modules/ticket.md).ProxyTicketDownloadData + +## Hierarchy + +- [`TicketDownloadData`](ticket.TicketDownloadData.md) + + ↳ **`ProxyTicketDownloadData`** + +## Table of contents + +### Constructors + +- [constructor](ticket.ProxyTicketDownloadData.md#constructor) + +### Properties + +- [address](ticket.ProxyTicketDownloadData.md#address) +- [method](ticket.ProxyTicketDownloadData.md#method) +- [params](ticket.ProxyTicketDownloadData.md#params) +- [plcCertificate](ticket.ProxyTicketDownloadData.md#plccertificate) +- [protocol](ticket.ProxyTicketDownloadData.md#protocol) +- [proxyAddress](ticket.ProxyTicketDownloadData.md#proxyaddress) +- [response](ticket.ProxyTicketDownloadData.md#response) +- [token](ticket.ProxyTicketDownloadData.md#token) +- [verifyTls](ticket.ProxyTicketDownloadData.md#verifytls) + +### Methods + +- [\_\_str\_\_](ticket.ProxyTicketDownloadData.md#__str__) +- [body](ticket.ProxyTicketDownloadData.md#body) +- [execute](ticket.ProxyTicketDownloadData.md#execute) +- [format\_response](ticket.ProxyTicketDownloadData.md#format_response) +- [gethttpsAgent](ticket.ProxyTicketDownloadData.md#gethttpsagent) +- [headers](ticket.ProxyTicketDownloadData.md#headers) +- [parse](ticket.ProxyTicketDownloadData.md#parse) +- [request](ticket.ProxyTicketDownloadData.md#request) +- [url](ticket.ProxyTicketDownloadData.md#url) + +## Constructors + +### constructor + +• **new ProxyTicketDownloadData**(`config`, `ticket_id`, `proxyAddress`, `token?`): [`ProxyTicketDownloadData`](ticket.ProxyTicketDownloadData.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `ticket_id` | `string` | +| `proxyAddress` | `string` | +| `token?` | `string` | + +#### Returns + +[`ProxyTicketDownloadData`](ticket.ProxyTicketDownloadData.md) + +#### Overrides + +[TicketDownloadData](ticket.TicketDownloadData.md).[constructor](ticket.TicketDownloadData.md#constructor) + +#### Defined in + +ticket.ts:163 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[address](ticket.TicketDownloadData.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[method](ticket.TicketDownloadData.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[params](ticket.TicketDownloadData.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[plcCertificate](ticket.TicketDownloadData.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[protocol](ticket.TicketDownloadData.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### proxyAddress + +• **proxyAddress**: `string` + +#### Defined in + +ticket.ts:161 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[response](ticket.TicketDownloadData.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[token](ticket.TicketDownloadData.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[verifyTls](ticket.TicketDownloadData.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[__str__](ticket.TicketDownloadData.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): ``null`` + +#### Returns + +``null`` + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[body](ticket.TicketDownloadData.md#body) + +#### Defined in + +ticket.ts:13 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[execute](ticket.TicketDownloadData.md#execute) + +#### Defined in + +ticket.ts:50 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[format_response](ticket.TicketDownloadData.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[gethttpsAgent](ticket.TicketDownloadData.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/octet-stream"; `X-Auth-Token`: `string` ; `x-plc-ip`: `string` } \| \{ `Content-type`: `string` = "application/octet-stream"; `X-Auth-Token?`: `undefined` ; `x-plc-ip?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/octet-stream"; `X-Auth-Token`: `string` ; `x-plc-ip`: `string` } \| \{ `Content-type`: `string` = "application/octet-stream"; `X-Auth-Token?`: `undefined` ; `x-plc-ip?`: `undefined` } + +#### Overrides + +[TicketDownloadData](ticket.TicketDownloadData.md).[headers](ticket.TicketDownloadData.md#headers) + +#### Defined in + +ticket.ts:177 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[parse](ticket.TicketDownloadData.md#parse) + +#### Defined in + +request.ts:206 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[request](ticket.TicketDownloadData.md#request) + +#### Defined in + +ticket.ts:38 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Overrides + +[TicketDownloadData](ticket.TicketDownloadData.md).[url](ticket.TicketDownloadData.md#url) + +#### Defined in + +ticket.ts:168 diff --git a/docs/classes/ticket.ProxyTicketUploadData.md b/docs/classes/ticket.ProxyTicketUploadData.md new file mode 100644 index 0000000..a3f5f7f --- /dev/null +++ b/docs/classes/ticket.ProxyTicketUploadData.md @@ -0,0 +1,178 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [ticket](../modules/ticket.md) / ProxyTicketUploadData + +# Class: ProxyTicketUploadData + +[ticket](../modules/ticket.md).ProxyTicketUploadData + +## Table of contents + +### Constructors + +- [constructor](ticket.ProxyTicketUploadData.md#constructor) + +### Properties + +- [address](ticket.ProxyTicketUploadData.md#address) +- [data](ticket.ProxyTicketUploadData.md#data) +- [proxyAddress](ticket.ProxyTicketUploadData.md#proxyaddress) +- [ticket\_id](ticket.ProxyTicketUploadData.md#ticket_id) +- [token](ticket.ProxyTicketUploadData.md#token) + +### Methods + +- [execute](ticket.ProxyTicketUploadData.md#execute) +- [gethttpsAgent](ticket.ProxyTicketUploadData.md#gethttpsagent) +- [headers](ticket.ProxyTicketUploadData.md#headers) +- [request](ticket.ProxyTicketUploadData.md#request) +- [url](ticket.ProxyTicketUploadData.md#url) + +## Constructors + +### constructor + +• **new ProxyTicketUploadData**(`proxyAddress`, `address`, `ticket_id`, `data`, `token`): [`ProxyTicketUploadData`](ticket.ProxyTicketUploadData.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `proxyAddress` | `string` | +| `address` | `string` | +| `ticket_id` | `string` | +| `data` | `Uint8Array` | +| `token` | `string` | + +#### Returns + +[`ProxyTicketUploadData`](ticket.ProxyTicketUploadData.md) + +#### Defined in + +ticket.ts:194 + +## Properties + +### address + +• **address**: `string` + +#### Defined in + +ticket.ts:191 + +___ + +### data + +• **data**: `Uint8Array` + +#### Defined in + +ticket.ts:189 + +___ + +### proxyAddress + +• **proxyAddress**: `string` + +#### Defined in + +ticket.ts:188 + +___ + +### ticket\_id + +• **ticket\_id**: `string` + +#### Defined in + +ticket.ts:192 + +___ + +### token + +• **token**: `string` + +#### Defined in + +ticket.ts:190 + +## Methods + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Defined in + +ticket.ts:235 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Defined in + +ticket.ts:217 + +___ + +### headers + +▸ **headers**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `Content-type` | `string` | +| `X-Auth-Token` | `string` | +| `x-plc-ip` | `string` | +| `x-plc-ticket` | `string` | + +#### Defined in + +ticket.ts:202 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Defined in + +ticket.ts:222 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Defined in + +ticket.ts:210 diff --git a/docs/classes/ticket.TicketDownloadData.md b/docs/classes/ticket.TicketDownloadData.md new file mode 100644 index 0000000..2d30565 --- /dev/null +++ b/docs/classes/ticket.TicketDownloadData.md @@ -0,0 +1,387 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [ticket](../modules/ticket.md) / TicketDownloadData + +# Class: TicketDownloadData + +[ticket](../modules/ticket.md).TicketDownloadData + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`TicketDownloadData`** + + ↳↳ [`TicketUploadData`](ticket.TicketUploadData.md) + + ↳↳ [`ProxyTicketDownloadData`](ticket.ProxyTicketDownloadData.md) + +## Table of contents + +### Constructors + +- [constructor](ticket.TicketDownloadData.md#constructor) + +### Properties + +- [address](ticket.TicketDownloadData.md#address) +- [method](ticket.TicketDownloadData.md#method) +- [params](ticket.TicketDownloadData.md#params) +- [plcCertificate](ticket.TicketDownloadData.md#plccertificate) +- [protocol](ticket.TicketDownloadData.md#protocol) +- [response](ticket.TicketDownloadData.md#response) +- [token](ticket.TicketDownloadData.md#token) +- [verifyTls](ticket.TicketDownloadData.md#verifytls) + +### Methods + +- [\_\_str\_\_](ticket.TicketDownloadData.md#__str__) +- [body](ticket.TicketDownloadData.md#body) +- [execute](ticket.TicketDownloadData.md#execute) +- [format\_response](ticket.TicketDownloadData.md#format_response) +- [gethttpsAgent](ticket.TicketDownloadData.md#gethttpsagent) +- [headers](ticket.TicketDownloadData.md#headers) +- [parse](ticket.TicketDownloadData.md#parse) +- [request](ticket.TicketDownloadData.md#request) +- [url](ticket.TicketDownloadData.md#url) + +## Constructors + +### constructor + +• **new TicketDownloadData**(`config`, `ticket_id`, `token?`): [`TicketDownloadData`](ticket.TicketDownloadData.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `ticket_id` | `string` | +| `token?` | `string` | + +#### Returns + +[`TicketDownloadData`](ticket.TicketDownloadData.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +ticket.ts:7 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): ``null`` + +#### Returns + +``null`` + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +ticket.ts:13 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +ticket.ts:50 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +request.ts:206 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +ticket.ts:38 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +ticket.ts:27 diff --git a/docs/classes/ticket.TicketUploadData.md b/docs/classes/ticket.TicketUploadData.md new file mode 100644 index 0000000..e7cd8e5 --- /dev/null +++ b/docs/classes/ticket.TicketUploadData.md @@ -0,0 +1,395 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [ticket](../modules/ticket.md) / TicketUploadData + +# Class: TicketUploadData + +[ticket](../modules/ticket.md).TicketUploadData + +## Hierarchy + +- [`TicketDownloadData`](ticket.TicketDownloadData.md) + + ↳ **`TicketUploadData`** + +## Table of contents + +### Constructors + +- [constructor](ticket.TicketUploadData.md#constructor) + +### Properties + +- [address](ticket.TicketUploadData.md#address) +- [data](ticket.TicketUploadData.md#data) +- [method](ticket.TicketUploadData.md#method) +- [params](ticket.TicketUploadData.md#params) +- [plcCertificate](ticket.TicketUploadData.md#plccertificate) +- [protocol](ticket.TicketUploadData.md#protocol) +- [response](ticket.TicketUploadData.md#response) +- [token](ticket.TicketUploadData.md#token) +- [verifyTls](ticket.TicketUploadData.md#verifytls) + +### Methods + +- [\_\_str\_\_](ticket.TicketUploadData.md#__str__) +- [body](ticket.TicketUploadData.md#body) +- [execute](ticket.TicketUploadData.md#execute) +- [format\_response](ticket.TicketUploadData.md#format_response) +- [gethttpsAgent](ticket.TicketUploadData.md#gethttpsagent) +- [headers](ticket.TicketUploadData.md#headers) +- [parse](ticket.TicketUploadData.md#parse) +- [request](ticket.TicketUploadData.md#request) +- [url](ticket.TicketUploadData.md#url) + +## Constructors + +### constructor + +• **new TicketUploadData**(`config`, `ticket_id`, `data`, `token`): [`TicketUploadData`](ticket.TicketUploadData.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `ticket_id` | `string` | +| `data` | `Uint8Array` | +| `token` | `string` | + +#### Returns + +[`TicketUploadData`](ticket.TicketUploadData.md) + +#### Overrides + +[TicketDownloadData](ticket.TicketDownloadData.md).[constructor](ticket.TicketDownloadData.md#constructor) + +#### Defined in + +ticket.ts:97 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[address](ticket.TicketDownloadData.md#address) + +#### Defined in + +request.ts:63 + +___ + +### data + +• **data**: `Uint8Array` + +#### Defined in + +ticket.ts:96 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[method](ticket.TicketDownloadData.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[params](ticket.TicketDownloadData.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[plcCertificate](ticket.TicketDownloadData.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[protocol](ticket.TicketDownloadData.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[response](ticket.TicketDownloadData.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[token](ticket.TicketDownloadData.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[verifyTls](ticket.TicketDownloadData.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[__str__](ticket.TicketDownloadData.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): ``null`` + +#### Returns + +``null`` + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[body](ticket.TicketDownloadData.md#body) + +#### Defined in + +ticket.ts:13 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Overrides + +[TicketDownloadData](ticket.TicketDownloadData.md).[execute](ticket.TicketDownloadData.md#execute) + +#### Defined in + +ticket.ts:125 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[format_response](ticket.TicketDownloadData.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[gethttpsAgent](ticket.TicketDownloadData.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/octet-stream"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/octet-stream"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/octet-stream"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/octet-stream"; `X-Auth-Token?`: `undefined` } + +#### Overrides + +[TicketDownloadData](ticket.TicketDownloadData.md).[headers](ticket.TicketDownloadData.md#headers) + +#### Defined in + +ticket.ts:102 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[parse](ticket.TicketDownloadData.md#parse) + +#### Defined in + +request.ts:206 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Overrides + +[TicketDownloadData](ticket.TicketDownloadData.md).[request](ticket.TicketDownloadData.md#request) + +#### Defined in + +ticket.ts:110 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[TicketDownloadData](ticket.TicketDownloadData.md).[url](ticket.TicketDownloadData.md#url) + +#### Defined in + +ticket.ts:27 diff --git a/docs/classes/webApp.Application.md b/docs/classes/webApp.Application.md new file mode 100644 index 0000000..ed287f6 --- /dev/null +++ b/docs/classes/webApp.Application.md @@ -0,0 +1,57 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / Application + +# Class: Application + +[webApp](../modules/webApp.md).Application + +## Table of contents + +### Constructors + +- [constructor](webApp.Application.md#constructor) + +### Properties + +- [name](webApp.Application.md#name) +- [state](webApp.Application.md#state) +- [type](webApp.Application.md#type) + +## Constructors + +### constructor + +• **new Application**(): [`Application`](webApp.Application.md) + +#### Returns + +[`Application`](webApp.Application.md) + +## Properties + +### name + +• **name**: `string` = `''` + +#### Defined in + +webApp.ts:439 + +___ + +### state + +• **state**: `string` = `''` + +#### Defined in + +webApp.ts:440 + +___ + +### type + +• **type**: `string` = `''` + +#### Defined in + +webApp.ts:441 diff --git a/docs/classes/webApp.BrowseResourcesStructure.md b/docs/classes/webApp.BrowseResourcesStructure.md new file mode 100644 index 0000000..d2cadad --- /dev/null +++ b/docs/classes/webApp.BrowseResourcesStructure.md @@ -0,0 +1,46 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / BrowseResourcesStructure + +# Class: BrowseResourcesStructure + +[webApp](../modules/webApp.md).BrowseResourcesStructure + +## Table of contents + +### Constructors + +- [constructor](webApp.BrowseResourcesStructure.md#constructor) + +### Properties + +- [max\_resources](webApp.BrowseResourcesStructure.md#max_resources) +- [resources](webApp.BrowseResourcesStructure.md#resources) + +## Constructors + +### constructor + +• **new BrowseResourcesStructure**(): [`BrowseResourcesStructure`](webApp.BrowseResourcesStructure.md) + +#### Returns + +[`BrowseResourcesStructure`](webApp.BrowseResourcesStructure.md) + +## Properties + +### max\_resources + +• **max\_resources**: `number` = `0` + +#### Defined in + +webApp.ts:525 + +___ + +### resources + +• **resources**: [`Resource`](webApp.Resource.md)[] = `[]` + +#### Defined in + +webApp.ts:526 diff --git a/docs/classes/webApp.BrowseStructure.md b/docs/classes/webApp.BrowseStructure.md new file mode 100644 index 0000000..82277b0 --- /dev/null +++ b/docs/classes/webApp.BrowseStructure.md @@ -0,0 +1,46 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / BrowseStructure + +# Class: BrowseStructure + +[webApp](../modules/webApp.md).BrowseStructure + +## Table of contents + +### Constructors + +- [constructor](webApp.BrowseStructure.md#constructor) + +### Properties + +- [applications](webApp.BrowseStructure.md#applications) +- [max\_applications](webApp.BrowseStructure.md#max_applications) + +## Constructors + +### constructor + +• **new BrowseStructure**(): [`BrowseStructure`](webApp.BrowseStructure.md) + +#### Returns + +[`BrowseStructure`](webApp.BrowseStructure.md) + +## Properties + +### applications + +• **applications**: [`Application`](webApp.Application.md)[] = `[]` + +#### Defined in + +webApp.ts:446 + +___ + +### max\_applications + +• **max\_applications**: `number` = `0` + +#### Defined in + +webApp.ts:445 diff --git a/docs/classes/webApp.Resource.md b/docs/classes/webApp.Resource.md new file mode 100644 index 0000000..2b3b5ac --- /dev/null +++ b/docs/classes/webApp.Resource.md @@ -0,0 +1,90 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / Resource + +# Class: Resource + +[webApp](../modules/webApp.md).Resource + +## Table of contents + +### Constructors + +- [constructor](webApp.Resource.md#constructor) + +### Properties + +- [etag](webApp.Resource.md#etag) +- [last\_modified](webApp.Resource.md#last_modified) +- [media\_type](webApp.Resource.md#media_type) +- [name](webApp.Resource.md#name) +- [size](webApp.Resource.md#size) +- [visibility](webApp.Resource.md#visibility) + +## Constructors + +### constructor + +• **new Resource**(): [`Resource`](webApp.Resource.md) + +#### Returns + +[`Resource`](webApp.Resource.md) + +## Properties + +### etag + +• `Optional` **etag**: `string` + +#### Defined in + +webApp.ts:520 + +___ + +### last\_modified + +• **last\_modified**: `string` = `''` + +#### Defined in + +webApp.ts:522 + +___ + +### media\_type + +• **media\_type**: `string` = `''` + +#### Defined in + +webApp.ts:519 + +___ + +### name + +• **name**: `string` = `''` + +#### Defined in + +webApp.ts:517 + +___ + +### size + +• **size**: `number` = `0` + +#### Defined in + +webApp.ts:518 + +___ + +### visibility + +• **visibility**: `string` = `''` + +#### Defined in + +webApp.ts:521 diff --git a/docs/classes/webApp.WebAppBrowse.md b/docs/classes/webApp.WebAppBrowse.md new file mode 100644 index 0000000..2e5fdc5 --- /dev/null +++ b/docs/classes/webApp.WebAppBrowse.md @@ -0,0 +1,382 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppBrowse + +# Class: WebAppBrowse + +[webApp](../modules/webApp.md).WebAppBrowse + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`WebAppBrowse`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppBrowse.md#constructor) + +### Properties + +- [address](webApp.WebAppBrowse.md#address) +- [method](webApp.WebAppBrowse.md#method) +- [params](webApp.WebAppBrowse.md#params) +- [plcCertificate](webApp.WebAppBrowse.md#plccertificate) +- [protocol](webApp.WebAppBrowse.md#protocol) +- [response](webApp.WebAppBrowse.md#response) +- [token](webApp.WebAppBrowse.md#token) +- [verifyTls](webApp.WebAppBrowse.md#verifytls) + +### Methods + +- [\_\_str\_\_](webApp.WebAppBrowse.md#__str__) +- [body](webApp.WebAppBrowse.md#body) +- [execute](webApp.WebAppBrowse.md#execute) +- [format\_response](webApp.WebAppBrowse.md#format_response) +- [gethttpsAgent](webApp.WebAppBrowse.md#gethttpsagent) +- [headers](webApp.WebAppBrowse.md#headers) +- [parse](webApp.WebAppBrowse.md#parse) +- [request](webApp.WebAppBrowse.md#request) +- [url](webApp.WebAppBrowse.md#url) + +## Constructors + +### constructor + +• **new WebAppBrowse**(`config`, `name?`): [`WebAppBrowse`](webApp.WebAppBrowse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `name?` | `string` | + +#### Returns + +[`WebAppBrowse`](webApp.WebAppBrowse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +webApp.ts:450 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`WebAppBrowseResponse`](webApp.WebAppBrowseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`WebAppBrowseResponse`](webApp.WebAppBrowseResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +webApp.ts:459 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/webApp.WebAppBrowseResources.md b/docs/classes/webApp.WebAppBrowseResources.md new file mode 100644 index 0000000..c7044bf --- /dev/null +++ b/docs/classes/webApp.WebAppBrowseResources.md @@ -0,0 +1,384 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppBrowseResources + +# Class: WebAppBrowseResources + +[webApp](../modules/webApp.md).WebAppBrowseResources + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`WebAppBrowseResources`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppBrowseResources.md#constructor) + +### Properties + +- [address](webApp.WebAppBrowseResources.md#address) +- [method](webApp.WebAppBrowseResources.md#method) +- [params](webApp.WebAppBrowseResources.md#params) +- [plcCertificate](webApp.WebAppBrowseResources.md#plccertificate) +- [protocol](webApp.WebAppBrowseResources.md#protocol) +- [response](webApp.WebAppBrowseResources.md#response) +- [token](webApp.WebAppBrowseResources.md#token) +- [verifyTls](webApp.WebAppBrowseResources.md#verifytls) + +### Methods + +- [\_\_str\_\_](webApp.WebAppBrowseResources.md#__str__) +- [body](webApp.WebAppBrowseResources.md#body) +- [execute](webApp.WebAppBrowseResources.md#execute) +- [format\_response](webApp.WebAppBrowseResources.md#format_response) +- [gethttpsAgent](webApp.WebAppBrowseResources.md#gethttpsagent) +- [headers](webApp.WebAppBrowseResources.md#headers) +- [parse](webApp.WebAppBrowseResources.md#parse) +- [request](webApp.WebAppBrowseResources.md#request) +- [url](webApp.WebAppBrowseResources.md#url) + +## Constructors + +### constructor + +• **new WebAppBrowseResources**(`config`, `token`, `app_name`, `name?`): [`WebAppBrowseResources`](webApp.WebAppBrowseResources.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `app_name` | `string` | +| `name?` | `string` | + +#### Returns + +[`WebAppBrowseResources`](webApp.WebAppBrowseResources.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +webApp.ts:529 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`WebAppBrowseResourcesResponse`](webApp.WebAppBrowseResourcesResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`WebAppBrowseResourcesResponse`](webApp.WebAppBrowseResourcesResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +webApp.ts:539 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/webApp.WebAppBrowseResourcesResponse.md b/docs/classes/webApp.WebAppBrowseResourcesResponse.md new file mode 100644 index 0000000..fcf76a9 --- /dev/null +++ b/docs/classes/webApp.WebAppBrowseResourcesResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppBrowseResourcesResponse + +# Class: WebAppBrowseResourcesResponse + +[webApp](../modules/webApp.md).WebAppBrowseResourcesResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`WebAppBrowseResourcesResponse`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppBrowseResourcesResponse.md#constructor) + +### Properties + +- [error](webApp.WebAppBrowseResourcesResponse.md#error) +- [id](webApp.WebAppBrowseResourcesResponse.md#id) +- [kind](webApp.WebAppBrowseResourcesResponse.md#kind) +- [result](webApp.WebAppBrowseResourcesResponse.md#result) + +### Methods + +- [\_\_str\_\_](webApp.WebAppBrowseResourcesResponse.md#__str__) +- [is\_error](webApp.WebAppBrowseResourcesResponse.md#is_error) +- [parse](webApp.WebAppBrowseResourcesResponse.md#parse) + +## Constructors + +### constructor + +• **new WebAppBrowseResourcesResponse**(): [`WebAppBrowseResourcesResponse`](webApp.WebAppBrowseResourcesResponse.md) + +#### Returns + +[`WebAppBrowseResourcesResponse`](webApp.WebAppBrowseResourcesResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +webApp.ts:599 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: [`BrowseResourcesStructure`](webApp.BrowseResourcesStructure.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +webApp.ts:598 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/webApp.WebAppBrowseResponse.md b/docs/classes/webApp.WebAppBrowseResponse.md new file mode 100644 index 0000000..121cabe --- /dev/null +++ b/docs/classes/webApp.WebAppBrowseResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppBrowseResponse + +# Class: WebAppBrowseResponse + +[webApp](../modules/webApp.md).WebAppBrowseResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`WebAppBrowseResponse`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppBrowseResponse.md#constructor) + +### Properties + +- [error](webApp.WebAppBrowseResponse.md#error) +- [id](webApp.WebAppBrowseResponse.md#id) +- [kind](webApp.WebAppBrowseResponse.md#kind) +- [result](webApp.WebAppBrowseResponse.md#result) + +### Methods + +- [\_\_str\_\_](webApp.WebAppBrowseResponse.md#__str__) +- [is\_error](webApp.WebAppBrowseResponse.md#is_error) +- [parse](webApp.WebAppBrowseResponse.md#parse) + +## Constructors + +### constructor + +• **new WebAppBrowseResponse**(): [`WebAppBrowseResponse`](webApp.WebAppBrowseResponse.md) + +#### Returns + +[`WebAppBrowseResponse`](webApp.WebAppBrowseResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +webApp.ts:511 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: [`BrowseStructure`](webApp.BrowseStructure.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +webApp.ts:510 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/webApp.WebAppCreate.md b/docs/classes/webApp.WebAppCreate.md new file mode 100644 index 0000000..8f4bb2b --- /dev/null +++ b/docs/classes/webApp.WebAppCreate.md @@ -0,0 +1,384 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppCreate + +# Class: WebAppCreate + +[webApp](../modules/webApp.md).WebAppCreate + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`WebAppCreate`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppCreate.md#constructor) + +### Properties + +- [address](webApp.WebAppCreate.md#address) +- [method](webApp.WebAppCreate.md#method) +- [params](webApp.WebAppCreate.md#params) +- [plcCertificate](webApp.WebAppCreate.md#plccertificate) +- [protocol](webApp.WebAppCreate.md#protocol) +- [response](webApp.WebAppCreate.md#response) +- [token](webApp.WebAppCreate.md#token) +- [verifyTls](webApp.WebAppCreate.md#verifytls) + +### Methods + +- [\_\_str\_\_](webApp.WebAppCreate.md#__str__) +- [body](webApp.WebAppCreate.md#body) +- [execute](webApp.WebAppCreate.md#execute) +- [format\_response](webApp.WebAppCreate.md#format_response) +- [gethttpsAgent](webApp.WebAppCreate.md#gethttpsagent) +- [headers](webApp.WebAppCreate.md#headers) +- [parse](webApp.WebAppCreate.md#parse) +- [request](webApp.WebAppCreate.md#request) +- [url](webApp.WebAppCreate.md#url) + +## Constructors + +### constructor + +• **new WebAppCreate**(`config`, `token`, `name`, `state?`): [`WebAppCreate`](webApp.WebAppCreate.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `name` | `string` | +| `state?` | `string` | + +#### Returns + +[`WebAppCreate`](webApp.WebAppCreate.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +webApp.ts:6 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`WebAppCreateResponse`](webApp.WebAppCreateResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`WebAppCreateResponse`](webApp.WebAppCreateResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +webApp.ts:16 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/webApp.WebAppCreateResource.md b/docs/classes/webApp.WebAppCreateResource.md new file mode 100644 index 0000000..a2c1ab8 --- /dev/null +++ b/docs/classes/webApp.WebAppCreateResource.md @@ -0,0 +1,388 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppCreateResource + +# Class: WebAppCreateResource + +[webApp](../modules/webApp.md).WebAppCreateResource + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`WebAppCreateResource`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppCreateResource.md#constructor) + +### Properties + +- [address](webApp.WebAppCreateResource.md#address) +- [method](webApp.WebAppCreateResource.md#method) +- [params](webApp.WebAppCreateResource.md#params) +- [plcCertificate](webApp.WebAppCreateResource.md#plccertificate) +- [protocol](webApp.WebAppCreateResource.md#protocol) +- [response](webApp.WebAppCreateResource.md#response) +- [token](webApp.WebAppCreateResource.md#token) +- [verifyTls](webApp.WebAppCreateResource.md#verifytls) + +### Methods + +- [\_\_str\_\_](webApp.WebAppCreateResource.md#__str__) +- [body](webApp.WebAppCreateResource.md#body) +- [execute](webApp.WebAppCreateResource.md#execute) +- [format\_response](webApp.WebAppCreateResource.md#format_response) +- [gethttpsAgent](webApp.WebAppCreateResource.md#gethttpsagent) +- [headers](webApp.WebAppCreateResource.md#headers) +- [parse](webApp.WebAppCreateResource.md#parse) +- [request](webApp.WebAppCreateResource.md#request) +- [url](webApp.WebAppCreateResource.md#url) + +## Constructors + +### constructor + +• **new WebAppCreateResource**(`config`, `token`, `app_name`, `name`, `media_type`, `last_modified`, `visibility?`, `etag?`): [`WebAppCreateResource`](webApp.WebAppCreateResource.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `app_name` | `string` | +| `name` | `string` | +| `media_type` | `string` | +| `last_modified` | `string` | +| `visibility?` | `string` | +| `etag?` | `string` | + +#### Returns + +[`WebAppCreateResource`](webApp.WebAppCreateResource.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +webApp.ts:233 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`WebAppCreateResourceResponse`](webApp.WebAppCreateResourceResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`WebAppCreateResourceResponse`](webApp.WebAppCreateResourceResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +webApp.ts:248 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/webApp.WebAppCreateResourceResponse.md b/docs/classes/webApp.WebAppCreateResourceResponse.md new file mode 100644 index 0000000..ed8b702 --- /dev/null +++ b/docs/classes/webApp.WebAppCreateResourceResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppCreateResourceResponse + +# Class: WebAppCreateResourceResponse + +[webApp](../modules/webApp.md).WebAppCreateResourceResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`WebAppCreateResourceResponse`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppCreateResourceResponse.md#constructor) + +### Properties + +- [error](webApp.WebAppCreateResourceResponse.md#error) +- [id](webApp.WebAppCreateResourceResponse.md#id) +- [kind](webApp.WebAppCreateResourceResponse.md#kind) +- [result](webApp.WebAppCreateResourceResponse.md#result) + +### Methods + +- [\_\_str\_\_](webApp.WebAppCreateResourceResponse.md#__str__) +- [is\_error](webApp.WebAppCreateResourceResponse.md#is_error) +- [parse](webApp.WebAppCreateResourceResponse.md#parse) + +## Constructors + +### constructor + +• **new WebAppCreateResourceResponse**(): [`WebAppCreateResourceResponse`](webApp.WebAppCreateResourceResponse.md) + +#### Returns + +[`WebAppCreateResourceResponse`](webApp.WebAppCreateResourceResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +webApp.ts:265 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `string` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +webApp.ts:264 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/webApp.WebAppCreateResponse.md b/docs/classes/webApp.WebAppCreateResponse.md new file mode 100644 index 0000000..7f6f0f5 --- /dev/null +++ b/docs/classes/webApp.WebAppCreateResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppCreateResponse + +# Class: WebAppCreateResponse + +[webApp](../modules/webApp.md).WebAppCreateResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`WebAppCreateResponse`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppCreateResponse.md#constructor) + +### Properties + +- [error](webApp.WebAppCreateResponse.md#error) +- [id](webApp.WebAppCreateResponse.md#id) +- [kind](webApp.WebAppCreateResponse.md#kind) +- [result](webApp.WebAppCreateResponse.md#result) + +### Methods + +- [\_\_str\_\_](webApp.WebAppCreateResponse.md#__str__) +- [is\_error](webApp.WebAppCreateResponse.md#is_error) +- [parse](webApp.WebAppCreateResponse.md#parse) + +## Constructors + +### constructor + +• **new WebAppCreateResponse**(): [`WebAppCreateResponse`](webApp.WebAppCreateResponse.md) + +#### Returns + +[`WebAppCreateResponse`](webApp.WebAppCreateResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +webApp.ts:33 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +webApp.ts:32 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/webApp.WebAppDelete.md b/docs/classes/webApp.WebAppDelete.md new file mode 100644 index 0000000..5203aaf --- /dev/null +++ b/docs/classes/webApp.WebAppDelete.md @@ -0,0 +1,383 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppDelete + +# Class: WebAppDelete + +[webApp](../modules/webApp.md).WebAppDelete + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`WebAppDelete`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppDelete.md#constructor) + +### Properties + +- [address](webApp.WebAppDelete.md#address) +- [method](webApp.WebAppDelete.md#method) +- [params](webApp.WebAppDelete.md#params) +- [plcCertificate](webApp.WebAppDelete.md#plccertificate) +- [protocol](webApp.WebAppDelete.md#protocol) +- [response](webApp.WebAppDelete.md#response) +- [token](webApp.WebAppDelete.md#token) +- [verifyTls](webApp.WebAppDelete.md#verifytls) + +### Methods + +- [\_\_str\_\_](webApp.WebAppDelete.md#__str__) +- [body](webApp.WebAppDelete.md#body) +- [execute](webApp.WebAppDelete.md#execute) +- [format\_response](webApp.WebAppDelete.md#format_response) +- [gethttpsAgent](webApp.WebAppDelete.md#gethttpsagent) +- [headers](webApp.WebAppDelete.md#headers) +- [parse](webApp.WebAppDelete.md#parse) +- [request](webApp.WebAppDelete.md#request) +- [url](webApp.WebAppDelete.md#url) + +## Constructors + +### constructor + +• **new WebAppDelete**(`config`, `token`, `name`): [`WebAppDelete`](webApp.WebAppDelete.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `name` | `string` | + +#### Returns + +[`WebAppDelete`](webApp.WebAppDelete.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +webApp.ts:38 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`WebAppDeleteResponse`](webApp.WebAppDeleteResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`WebAppDeleteResponse`](webApp.WebAppDeleteResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +webApp.ts:43 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/webApp.WebAppDeleteResource.md b/docs/classes/webApp.WebAppDeleteResource.md new file mode 100644 index 0000000..aa117cf --- /dev/null +++ b/docs/classes/webApp.WebAppDeleteResource.md @@ -0,0 +1,384 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppDeleteResource + +# Class: WebAppDeleteResource + +[webApp](../modules/webApp.md).WebAppDeleteResource + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`WebAppDeleteResource`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppDeleteResource.md#constructor) + +### Properties + +- [address](webApp.WebAppDeleteResource.md#address) +- [method](webApp.WebAppDeleteResource.md#method) +- [params](webApp.WebAppDeleteResource.md#params) +- [plcCertificate](webApp.WebAppDeleteResource.md#plccertificate) +- [protocol](webApp.WebAppDeleteResource.md#protocol) +- [response](webApp.WebAppDeleteResource.md#response) +- [token](webApp.WebAppDeleteResource.md#token) +- [verifyTls](webApp.WebAppDeleteResource.md#verifytls) + +### Methods + +- [\_\_str\_\_](webApp.WebAppDeleteResource.md#__str__) +- [body](webApp.WebAppDeleteResource.md#body) +- [execute](webApp.WebAppDeleteResource.md#execute) +- [format\_response](webApp.WebAppDeleteResource.md#format_response) +- [gethttpsAgent](webApp.WebAppDeleteResource.md#gethttpsagent) +- [headers](webApp.WebAppDeleteResource.md#headers) +- [parse](webApp.WebAppDeleteResource.md#parse) +- [request](webApp.WebAppDeleteResource.md#request) +- [url](webApp.WebAppDeleteResource.md#url) + +## Constructors + +### constructor + +• **new WebAppDeleteResource**(`config`, `token`, `app_name`, `name`): [`WebAppDeleteResource`](webApp.WebAppDeleteResource.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `app_name` | `string` | +| `name` | `string` | + +#### Returns + +[`WebAppDeleteResource`](webApp.WebAppDeleteResource.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +webApp.ts:270 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`WebAppDeleteResourceResponse`](webApp.WebAppDeleteResourceResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`WebAppDeleteResourceResponse`](webApp.WebAppDeleteResourceResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +webApp.ts:277 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/webApp.WebAppDeleteResourceResponse.md b/docs/classes/webApp.WebAppDeleteResourceResponse.md new file mode 100644 index 0000000..572859c --- /dev/null +++ b/docs/classes/webApp.WebAppDeleteResourceResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppDeleteResourceResponse + +# Class: WebAppDeleteResourceResponse + +[webApp](../modules/webApp.md).WebAppDeleteResourceResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`WebAppDeleteResourceResponse`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppDeleteResourceResponse.md#constructor) + +### Properties + +- [error](webApp.WebAppDeleteResourceResponse.md#error) +- [id](webApp.WebAppDeleteResourceResponse.md#id) +- [kind](webApp.WebAppDeleteResourceResponse.md#kind) +- [result](webApp.WebAppDeleteResourceResponse.md#result) + +### Methods + +- [\_\_str\_\_](webApp.WebAppDeleteResourceResponse.md#__str__) +- [is\_error](webApp.WebAppDeleteResourceResponse.md#is_error) +- [parse](webApp.WebAppDeleteResourceResponse.md#parse) + +## Constructors + +### constructor + +• **new WebAppDeleteResourceResponse**(): [`WebAppDeleteResourceResponse`](webApp.WebAppDeleteResourceResponse.md) + +#### Returns + +[`WebAppDeleteResourceResponse`](webApp.WebAppDeleteResourceResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +webApp.ts:293 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +webApp.ts:292 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/webApp.WebAppDeleteResponse.md b/docs/classes/webApp.WebAppDeleteResponse.md new file mode 100644 index 0000000..f0c15bc --- /dev/null +++ b/docs/classes/webApp.WebAppDeleteResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppDeleteResponse + +# Class: WebAppDeleteResponse + +[webApp](../modules/webApp.md).WebAppDeleteResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`WebAppDeleteResponse`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppDeleteResponse.md#constructor) + +### Properties + +- [error](webApp.WebAppDeleteResponse.md#error) +- [id](webApp.WebAppDeleteResponse.md#id) +- [kind](webApp.WebAppDeleteResponse.md#kind) +- [result](webApp.WebAppDeleteResponse.md#result) + +### Methods + +- [\_\_str\_\_](webApp.WebAppDeleteResponse.md#__str__) +- [is\_error](webApp.WebAppDeleteResponse.md#is_error) +- [parse](webApp.WebAppDeleteResponse.md#parse) + +## Constructors + +### constructor + +• **new WebAppDeleteResponse**(): [`WebAppDeleteResponse`](webApp.WebAppDeleteResponse.md) + +#### Returns + +[`WebAppDeleteResponse`](webApp.WebAppDeleteResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +webApp.ts:59 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +webApp.ts:58 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/webApp.WebAppDownloadResource.md b/docs/classes/webApp.WebAppDownloadResource.md new file mode 100644 index 0000000..50e8cd9 --- /dev/null +++ b/docs/classes/webApp.WebAppDownloadResource.md @@ -0,0 +1,384 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppDownloadResource + +# Class: WebAppDownloadResource + +[webApp](../modules/webApp.md).WebAppDownloadResource + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`WebAppDownloadResource`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppDownloadResource.md#constructor) + +### Properties + +- [address](webApp.WebAppDownloadResource.md#address) +- [method](webApp.WebAppDownloadResource.md#method) +- [params](webApp.WebAppDownloadResource.md#params) +- [plcCertificate](webApp.WebAppDownloadResource.md#plccertificate) +- [protocol](webApp.WebAppDownloadResource.md#protocol) +- [response](webApp.WebAppDownloadResource.md#response) +- [token](webApp.WebAppDownloadResource.md#token) +- [verifyTls](webApp.WebAppDownloadResource.md#verifytls) + +### Methods + +- [\_\_str\_\_](webApp.WebAppDownloadResource.md#__str__) +- [body](webApp.WebAppDownloadResource.md#body) +- [execute](webApp.WebAppDownloadResource.md#execute) +- [format\_response](webApp.WebAppDownloadResource.md#format_response) +- [gethttpsAgent](webApp.WebAppDownloadResource.md#gethttpsagent) +- [headers](webApp.WebAppDownloadResource.md#headers) +- [parse](webApp.WebAppDownloadResource.md#parse) +- [request](webApp.WebAppDownloadResource.md#request) +- [url](webApp.WebAppDownloadResource.md#url) + +## Constructors + +### constructor + +• **new WebAppDownloadResource**(`config`, `token`, `app_name`, `name`): [`WebAppDownloadResource`](webApp.WebAppDownloadResource.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `app_name` | `string` | +| `name` | `string` | + +#### Returns + +[`WebAppDownloadResource`](webApp.WebAppDownloadResource.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +webApp.ts:298 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`WebAppDownloadResourceResponse`](webApp.WebAppDownloadResourceResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`WebAppDownloadResourceResponse`](webApp.WebAppDownloadResourceResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +webApp.ts:305 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/webApp.WebAppDownloadResourceResponse.md b/docs/classes/webApp.WebAppDownloadResourceResponse.md new file mode 100644 index 0000000..decb9a4 --- /dev/null +++ b/docs/classes/webApp.WebAppDownloadResourceResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppDownloadResourceResponse + +# Class: WebAppDownloadResourceResponse + +[webApp](../modules/webApp.md).WebAppDownloadResourceResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`WebAppDownloadResourceResponse`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppDownloadResourceResponse.md#constructor) + +### Properties + +- [error](webApp.WebAppDownloadResourceResponse.md#error) +- [id](webApp.WebAppDownloadResourceResponse.md#id) +- [kind](webApp.WebAppDownloadResourceResponse.md#kind) +- [result](webApp.WebAppDownloadResourceResponse.md#result) + +### Methods + +- [\_\_str\_\_](webApp.WebAppDownloadResourceResponse.md#__str__) +- [is\_error](webApp.WebAppDownloadResourceResponse.md#is_error) +- [parse](webApp.WebAppDownloadResourceResponse.md#parse) + +## Constructors + +### constructor + +• **new WebAppDownloadResourceResponse**(): [`WebAppDownloadResourceResponse`](webApp.WebAppDownloadResourceResponse.md) + +#### Returns + +[`WebAppDownloadResourceResponse`](webApp.WebAppDownloadResourceResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +webApp.ts:322 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `string` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +webApp.ts:321 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/webApp.WebAppRename.md b/docs/classes/webApp.WebAppRename.md new file mode 100644 index 0000000..76a1890 --- /dev/null +++ b/docs/classes/webApp.WebAppRename.md @@ -0,0 +1,384 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppRename + +# Class: WebAppRename + +[webApp](../modules/webApp.md).WebAppRename + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`WebAppRename`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppRename.md#constructor) + +### Properties + +- [address](webApp.WebAppRename.md#address) +- [method](webApp.WebAppRename.md#method) +- [params](webApp.WebAppRename.md#params) +- [plcCertificate](webApp.WebAppRename.md#plccertificate) +- [protocol](webApp.WebAppRename.md#protocol) +- [response](webApp.WebAppRename.md#response) +- [token](webApp.WebAppRename.md#token) +- [verifyTls](webApp.WebAppRename.md#verifytls) + +### Methods + +- [\_\_str\_\_](webApp.WebAppRename.md#__str__) +- [body](webApp.WebAppRename.md#body) +- [execute](webApp.WebAppRename.md#execute) +- [format\_response](webApp.WebAppRename.md#format_response) +- [gethttpsAgent](webApp.WebAppRename.md#gethttpsagent) +- [headers](webApp.WebAppRename.md#headers) +- [parse](webApp.WebAppRename.md#parse) +- [request](webApp.WebAppRename.md#request) +- [url](webApp.WebAppRename.md#url) + +## Constructors + +### constructor + +• **new WebAppRename**(`config`, `token`, `name`, `new_name`): [`WebAppRename`](webApp.WebAppRename.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `name` | `string` | +| `new_name` | `string` | + +#### Returns + +[`WebAppRename`](webApp.WebAppRename.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +webApp.ts:65 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`WebAppRenameResponse`](webApp.WebAppRenameResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`WebAppRenameResponse`](webApp.WebAppRenameResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +webApp.ts:72 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/webApp.WebAppRenameResource.md b/docs/classes/webApp.WebAppRenameResource.md new file mode 100644 index 0000000..418d814 --- /dev/null +++ b/docs/classes/webApp.WebAppRenameResource.md @@ -0,0 +1,385 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppRenameResource + +# Class: WebAppRenameResource + +[webApp](../modules/webApp.md).WebAppRenameResource + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`WebAppRenameResource`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppRenameResource.md#constructor) + +### Properties + +- [address](webApp.WebAppRenameResource.md#address) +- [method](webApp.WebAppRenameResource.md#method) +- [params](webApp.WebAppRenameResource.md#params) +- [plcCertificate](webApp.WebAppRenameResource.md#plccertificate) +- [protocol](webApp.WebAppRenameResource.md#protocol) +- [response](webApp.WebAppRenameResource.md#response) +- [token](webApp.WebAppRenameResource.md#token) +- [verifyTls](webApp.WebAppRenameResource.md#verifytls) + +### Methods + +- [\_\_str\_\_](webApp.WebAppRenameResource.md#__str__) +- [body](webApp.WebAppRenameResource.md#body) +- [execute](webApp.WebAppRenameResource.md#execute) +- [format\_response](webApp.WebAppRenameResource.md#format_response) +- [gethttpsAgent](webApp.WebAppRenameResource.md#gethttpsagent) +- [headers](webApp.WebAppRenameResource.md#headers) +- [parse](webApp.WebAppRenameResource.md#parse) +- [request](webApp.WebAppRenameResource.md#request) +- [url](webApp.WebAppRenameResource.md#url) + +## Constructors + +### constructor + +• **new WebAppRenameResource**(`config`, `token`, `app_name`, `name`, `new_name`): [`WebAppRenameResource`](webApp.WebAppRenameResource.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `app_name` | `string` | +| `name` | `string` | +| `new_name` | `string` | + +#### Returns + +[`WebAppRenameResource`](webApp.WebAppRenameResource.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +webApp.ts:94 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`WebAppRenameResourceResponse`](webApp.WebAppRenameResourceResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`WebAppRenameResourceResponse`](webApp.WebAppRenameResourceResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +webApp.ts:99 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/webApp.WebAppRenameResourceResponse.md b/docs/classes/webApp.WebAppRenameResourceResponse.md new file mode 100644 index 0000000..ff2d7f9 --- /dev/null +++ b/docs/classes/webApp.WebAppRenameResourceResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppRenameResourceResponse + +# Class: WebAppRenameResourceResponse + +[webApp](../modules/webApp.md).WebAppRenameResourceResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`WebAppRenameResourceResponse`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppRenameResourceResponse.md#constructor) + +### Properties + +- [error](webApp.WebAppRenameResourceResponse.md#error) +- [id](webApp.WebAppRenameResourceResponse.md#id) +- [kind](webApp.WebAppRenameResourceResponse.md#kind) +- [result](webApp.WebAppRenameResourceResponse.md#result) + +### Methods + +- [\_\_str\_\_](webApp.WebAppRenameResourceResponse.md#__str__) +- [is\_error](webApp.WebAppRenameResourceResponse.md#is_error) +- [parse](webApp.WebAppRenameResourceResponse.md#parse) + +## Constructors + +### constructor + +• **new WebAppRenameResourceResponse**(): [`WebAppRenameResourceResponse`](webApp.WebAppRenameResourceResponse.md) + +#### Returns + +[`WebAppRenameResourceResponse`](webApp.WebAppRenameResourceResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +webApp.ts:115 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +webApp.ts:114 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/webApp.WebAppRenameResponse.md b/docs/classes/webApp.WebAppRenameResponse.md new file mode 100644 index 0000000..7faa9a0 --- /dev/null +++ b/docs/classes/webApp.WebAppRenameResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppRenameResponse + +# Class: WebAppRenameResponse + +[webApp](../modules/webApp.md).WebAppRenameResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`WebAppRenameResponse`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppRenameResponse.md#constructor) + +### Properties + +- [error](webApp.WebAppRenameResponse.md#error) +- [id](webApp.WebAppRenameResponse.md#id) +- [kind](webApp.WebAppRenameResponse.md#kind) +- [result](webApp.WebAppRenameResponse.md#result) + +### Methods + +- [\_\_str\_\_](webApp.WebAppRenameResponse.md#__str__) +- [is\_error](webApp.WebAppRenameResponse.md#is_error) +- [parse](webApp.WebAppRenameResponse.md#parse) + +## Constructors + +### constructor + +• **new WebAppRenameResponse**(): [`WebAppRenameResponse`](webApp.WebAppRenameResponse.md) + +#### Returns + +[`WebAppRenameResponse`](webApp.WebAppRenameResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +webApp.ts:89 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +webApp.ts:88 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/webApp.WebAppSetDefaultPage.md b/docs/classes/webApp.WebAppSetDefaultPage.md new file mode 100644 index 0000000..afd1618 --- /dev/null +++ b/docs/classes/webApp.WebAppSetDefaultPage.md @@ -0,0 +1,384 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppSetDefaultPage + +# Class: WebAppSetDefaultPage + +[webApp](../modules/webApp.md).WebAppSetDefaultPage + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`WebAppSetDefaultPage`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppSetDefaultPage.md#constructor) + +### Properties + +- [address](webApp.WebAppSetDefaultPage.md#address) +- [method](webApp.WebAppSetDefaultPage.md#method) +- [params](webApp.WebAppSetDefaultPage.md#params) +- [plcCertificate](webApp.WebAppSetDefaultPage.md#plccertificate) +- [protocol](webApp.WebAppSetDefaultPage.md#protocol) +- [response](webApp.WebAppSetDefaultPage.md#response) +- [token](webApp.WebAppSetDefaultPage.md#token) +- [verifyTls](webApp.WebAppSetDefaultPage.md#verifytls) + +### Methods + +- [\_\_str\_\_](webApp.WebAppSetDefaultPage.md#__str__) +- [body](webApp.WebAppSetDefaultPage.md#body) +- [execute](webApp.WebAppSetDefaultPage.md#execute) +- [format\_response](webApp.WebAppSetDefaultPage.md#format_response) +- [gethttpsAgent](webApp.WebAppSetDefaultPage.md#gethttpsagent) +- [headers](webApp.WebAppSetDefaultPage.md#headers) +- [parse](webApp.WebAppSetDefaultPage.md#parse) +- [request](webApp.WebAppSetDefaultPage.md#request) +- [url](webApp.WebAppSetDefaultPage.md#url) + +## Constructors + +### constructor + +• **new WebAppSetDefaultPage**(`config`, `token`, `name`, `resource_name`): [`WebAppSetDefaultPage`](webApp.WebAppSetDefaultPage.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `name` | `string` | +| `resource_name` | `string` | + +#### Returns + +[`WebAppSetDefaultPage`](webApp.WebAppSetDefaultPage.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +webApp.ts:149 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`WebAppSetDefaultPageResponse`](webApp.WebAppSetDefaultPageResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`WebAppSetDefaultPageResponse`](webApp.WebAppSetDefaultPageResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +webApp.ts:155 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/webApp.WebAppSetDefaultPageResponse.md b/docs/classes/webApp.WebAppSetDefaultPageResponse.md new file mode 100644 index 0000000..2c07f8a --- /dev/null +++ b/docs/classes/webApp.WebAppSetDefaultPageResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppSetDefaultPageResponse + +# Class: WebAppSetDefaultPageResponse + +[webApp](../modules/webApp.md).WebAppSetDefaultPageResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`WebAppSetDefaultPageResponse`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppSetDefaultPageResponse.md#constructor) + +### Properties + +- [error](webApp.WebAppSetDefaultPageResponse.md#error) +- [id](webApp.WebAppSetDefaultPageResponse.md#id) +- [kind](webApp.WebAppSetDefaultPageResponse.md#kind) +- [result](webApp.WebAppSetDefaultPageResponse.md#result) + +### Methods + +- [\_\_str\_\_](webApp.WebAppSetDefaultPageResponse.md#__str__) +- [is\_error](webApp.WebAppSetDefaultPageResponse.md#is_error) +- [parse](webApp.WebAppSetDefaultPageResponse.md#parse) + +## Constructors + +### constructor + +• **new WebAppSetDefaultPageResponse**(): [`WebAppSetDefaultPageResponse`](webApp.WebAppSetDefaultPageResponse.md) + +#### Returns + +[`WebAppSetDefaultPageResponse`](webApp.WebAppSetDefaultPageResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +webApp.ts:171 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +webApp.ts:170 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/webApp.WebAppSetNotAuthorizedPage.md b/docs/classes/webApp.WebAppSetNotAuthorizedPage.md new file mode 100644 index 0000000..7a7865e --- /dev/null +++ b/docs/classes/webApp.WebAppSetNotAuthorizedPage.md @@ -0,0 +1,384 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppSetNotAuthorizedPage + +# Class: WebAppSetNotAuthorizedPage + +[webApp](../modules/webApp.md).WebAppSetNotAuthorizedPage + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`WebAppSetNotAuthorizedPage`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppSetNotAuthorizedPage.md#constructor) + +### Properties + +- [address](webApp.WebAppSetNotAuthorizedPage.md#address) +- [method](webApp.WebAppSetNotAuthorizedPage.md#method) +- [params](webApp.WebAppSetNotAuthorizedPage.md#params) +- [plcCertificate](webApp.WebAppSetNotAuthorizedPage.md#plccertificate) +- [protocol](webApp.WebAppSetNotAuthorizedPage.md#protocol) +- [response](webApp.WebAppSetNotAuthorizedPage.md#response) +- [token](webApp.WebAppSetNotAuthorizedPage.md#token) +- [verifyTls](webApp.WebAppSetNotAuthorizedPage.md#verifytls) + +### Methods + +- [\_\_str\_\_](webApp.WebAppSetNotAuthorizedPage.md#__str__) +- [body](webApp.WebAppSetNotAuthorizedPage.md#body) +- [execute](webApp.WebAppSetNotAuthorizedPage.md#execute) +- [format\_response](webApp.WebAppSetNotAuthorizedPage.md#format_response) +- [gethttpsAgent](webApp.WebAppSetNotAuthorizedPage.md#gethttpsagent) +- [headers](webApp.WebAppSetNotAuthorizedPage.md#headers) +- [parse](webApp.WebAppSetNotAuthorizedPage.md#parse) +- [request](webApp.WebAppSetNotAuthorizedPage.md#request) +- [url](webApp.WebAppSetNotAuthorizedPage.md#url) + +## Constructors + +### constructor + +• **new WebAppSetNotAuthorizedPage**(`config`, `token`, `name`, `resource_name`): [`WebAppSetNotAuthorizedPage`](webApp.WebAppSetNotAuthorizedPage.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `name` | `string` | +| `resource_name` | `string` | + +#### Returns + +[`WebAppSetNotAuthorizedPage`](webApp.WebAppSetNotAuthorizedPage.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +webApp.ts:206 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`WebAppSetNotAuthorizedPageResponse`](webApp.WebAppSetNotAuthorizedPageResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`WebAppSetNotAuthorizedPageResponse`](webApp.WebAppSetNotAuthorizedPageResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +webApp.ts:212 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/webApp.WebAppSetNotAuthorizedPageResponse.md b/docs/classes/webApp.WebAppSetNotAuthorizedPageResponse.md new file mode 100644 index 0000000..f57bb95 --- /dev/null +++ b/docs/classes/webApp.WebAppSetNotAuthorizedPageResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppSetNotAuthorizedPageResponse + +# Class: WebAppSetNotAuthorizedPageResponse + +[webApp](../modules/webApp.md).WebAppSetNotAuthorizedPageResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`WebAppSetNotAuthorizedPageResponse`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppSetNotAuthorizedPageResponse.md#constructor) + +### Properties + +- [error](webApp.WebAppSetNotAuthorizedPageResponse.md#error) +- [id](webApp.WebAppSetNotAuthorizedPageResponse.md#id) +- [kind](webApp.WebAppSetNotAuthorizedPageResponse.md#kind) +- [result](webApp.WebAppSetNotAuthorizedPageResponse.md#result) + +### Methods + +- [\_\_str\_\_](webApp.WebAppSetNotAuthorizedPageResponse.md#__str__) +- [is\_error](webApp.WebAppSetNotAuthorizedPageResponse.md#is_error) +- [parse](webApp.WebAppSetNotAuthorizedPageResponse.md#parse) + +## Constructors + +### constructor + +• **new WebAppSetNotAuthorizedPageResponse**(): [`WebAppSetNotAuthorizedPageResponse`](webApp.WebAppSetNotAuthorizedPageResponse.md) + +#### Returns + +[`WebAppSetNotAuthorizedPageResponse`](webApp.WebAppSetNotAuthorizedPageResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +webApp.ts:228 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +webApp.ts:227 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/webApp.WebAppSetNotFoundPage.md b/docs/classes/webApp.WebAppSetNotFoundPage.md new file mode 100644 index 0000000..7c94abb --- /dev/null +++ b/docs/classes/webApp.WebAppSetNotFoundPage.md @@ -0,0 +1,384 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppSetNotFoundPage + +# Class: WebAppSetNotFoundPage + +[webApp](../modules/webApp.md).WebAppSetNotFoundPage + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`WebAppSetNotFoundPage`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppSetNotFoundPage.md#constructor) + +### Properties + +- [address](webApp.WebAppSetNotFoundPage.md#address) +- [method](webApp.WebAppSetNotFoundPage.md#method) +- [params](webApp.WebAppSetNotFoundPage.md#params) +- [plcCertificate](webApp.WebAppSetNotFoundPage.md#plccertificate) +- [protocol](webApp.WebAppSetNotFoundPage.md#protocol) +- [response](webApp.WebAppSetNotFoundPage.md#response) +- [token](webApp.WebAppSetNotFoundPage.md#token) +- [verifyTls](webApp.WebAppSetNotFoundPage.md#verifytls) + +### Methods + +- [\_\_str\_\_](webApp.WebAppSetNotFoundPage.md#__str__) +- [body](webApp.WebAppSetNotFoundPage.md#body) +- [execute](webApp.WebAppSetNotFoundPage.md#execute) +- [format\_response](webApp.WebAppSetNotFoundPage.md#format_response) +- [gethttpsAgent](webApp.WebAppSetNotFoundPage.md#gethttpsagent) +- [headers](webApp.WebAppSetNotFoundPage.md#headers) +- [parse](webApp.WebAppSetNotFoundPage.md#parse) +- [request](webApp.WebAppSetNotFoundPage.md#request) +- [url](webApp.WebAppSetNotFoundPage.md#url) + +## Constructors + +### constructor + +• **new WebAppSetNotFoundPage**(`config`, `token`, `name`, `resource_name`): [`WebAppSetNotFoundPage`](webApp.WebAppSetNotFoundPage.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `name` | `string` | +| `resource_name` | `string` | + +#### Returns + +[`WebAppSetNotFoundPage`](webApp.WebAppSetNotFoundPage.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +webApp.ts:178 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`WebAppSetNotFoundPageResponse`](webApp.WebAppSetNotFoundPageResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`WebAppSetNotFoundPageResponse`](webApp.WebAppSetNotFoundPageResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +webApp.ts:184 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/webApp.WebAppSetNotFoundPageResponse.md b/docs/classes/webApp.WebAppSetNotFoundPageResponse.md new file mode 100644 index 0000000..aff34c1 --- /dev/null +++ b/docs/classes/webApp.WebAppSetNotFoundPageResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppSetNotFoundPageResponse + +# Class: WebAppSetNotFoundPageResponse + +[webApp](../modules/webApp.md).WebAppSetNotFoundPageResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`WebAppSetNotFoundPageResponse`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppSetNotFoundPageResponse.md#constructor) + +### Properties + +- [error](webApp.WebAppSetNotFoundPageResponse.md#error) +- [id](webApp.WebAppSetNotFoundPageResponse.md#id) +- [kind](webApp.WebAppSetNotFoundPageResponse.md#kind) +- [result](webApp.WebAppSetNotFoundPageResponse.md#result) + +### Methods + +- [\_\_str\_\_](webApp.WebAppSetNotFoundPageResponse.md#__str__) +- [is\_error](webApp.WebAppSetNotFoundPageResponse.md#is_error) +- [parse](webApp.WebAppSetNotFoundPageResponse.md#parse) + +## Constructors + +### constructor + +• **new WebAppSetNotFoundPageResponse**(): [`WebAppSetNotFoundPageResponse`](webApp.WebAppSetNotFoundPageResponse.md) + +#### Returns + +[`WebAppSetNotFoundPageResponse`](webApp.WebAppSetNotFoundPageResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +webApp.ts:200 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +webApp.ts:199 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/webApp.WebAppSetResourceETag.md b/docs/classes/webApp.WebAppSetResourceETag.md new file mode 100644 index 0000000..a749d96 --- /dev/null +++ b/docs/classes/webApp.WebAppSetResourceETag.md @@ -0,0 +1,385 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppSetResourceETag + +# Class: WebAppSetResourceETag + +[webApp](../modules/webApp.md).WebAppSetResourceETag + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`WebAppSetResourceETag`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppSetResourceETag.md#constructor) + +### Properties + +- [address](webApp.WebAppSetResourceETag.md#address) +- [method](webApp.WebAppSetResourceETag.md#method) +- [params](webApp.WebAppSetResourceETag.md#params) +- [plcCertificate](webApp.WebAppSetResourceETag.md#plccertificate) +- [protocol](webApp.WebAppSetResourceETag.md#protocol) +- [response](webApp.WebAppSetResourceETag.md#response) +- [token](webApp.WebAppSetResourceETag.md#token) +- [verifyTls](webApp.WebAppSetResourceETag.md#verifytls) + +### Methods + +- [\_\_str\_\_](webApp.WebAppSetResourceETag.md#__str__) +- [body](webApp.WebAppSetResourceETag.md#body) +- [execute](webApp.WebAppSetResourceETag.md#execute) +- [format\_response](webApp.WebAppSetResourceETag.md#format_response) +- [gethttpsAgent](webApp.WebAppSetResourceETag.md#gethttpsagent) +- [headers](webApp.WebAppSetResourceETag.md#headers) +- [parse](webApp.WebAppSetResourceETag.md#parse) +- [request](webApp.WebAppSetResourceETag.md#request) +- [url](webApp.WebAppSetResourceETag.md#url) + +## Constructors + +### constructor + +• **new WebAppSetResourceETag**(`config`, `token`, `app_name`, `name`, `etag`): [`WebAppSetResourceETag`](webApp.WebAppSetResourceETag.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `app_name` | `string` | +| `name` | `string` | +| `etag` | `string` | + +#### Returns + +[`WebAppSetResourceETag`](webApp.WebAppSetResourceETag.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +webApp.ts:328 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`WebAppSetResourceETagResponse`](webApp.WebAppSetResourceETagResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`WebAppSetResourceETagResponse`](webApp.WebAppSetResourceETagResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +webApp.ts:334 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/webApp.WebAppSetResourceETagResponse.md b/docs/classes/webApp.WebAppSetResourceETagResponse.md new file mode 100644 index 0000000..376da8c --- /dev/null +++ b/docs/classes/webApp.WebAppSetResourceETagResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppSetResourceETagResponse + +# Class: WebAppSetResourceETagResponse + +[webApp](../modules/webApp.md).WebAppSetResourceETagResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`WebAppSetResourceETagResponse`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppSetResourceETagResponse.md#constructor) + +### Properties + +- [error](webApp.WebAppSetResourceETagResponse.md#error) +- [id](webApp.WebAppSetResourceETagResponse.md#id) +- [kind](webApp.WebAppSetResourceETagResponse.md#kind) +- [result](webApp.WebAppSetResourceETagResponse.md#result) + +### Methods + +- [\_\_str\_\_](webApp.WebAppSetResourceETagResponse.md#__str__) +- [is\_error](webApp.WebAppSetResourceETagResponse.md#is_error) +- [parse](webApp.WebAppSetResourceETagResponse.md#parse) + +## Constructors + +### constructor + +• **new WebAppSetResourceETagResponse**(): [`WebAppSetResourceETagResponse`](webApp.WebAppSetResourceETagResponse.md) + +#### Returns + +[`WebAppSetResourceETagResponse`](webApp.WebAppSetResourceETagResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +webApp.ts:350 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +webApp.ts:349 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/webApp.WebAppSetResourceMediaType.md b/docs/classes/webApp.WebAppSetResourceMediaType.md new file mode 100644 index 0000000..065f8e8 --- /dev/null +++ b/docs/classes/webApp.WebAppSetResourceMediaType.md @@ -0,0 +1,385 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppSetResourceMediaType + +# Class: WebAppSetResourceMediaType + +[webApp](../modules/webApp.md).WebAppSetResourceMediaType + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`WebAppSetResourceMediaType`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppSetResourceMediaType.md#constructor) + +### Properties + +- [address](webApp.WebAppSetResourceMediaType.md#address) +- [method](webApp.WebAppSetResourceMediaType.md#method) +- [params](webApp.WebAppSetResourceMediaType.md#params) +- [plcCertificate](webApp.WebAppSetResourceMediaType.md#plccertificate) +- [protocol](webApp.WebAppSetResourceMediaType.md#protocol) +- [response](webApp.WebAppSetResourceMediaType.md#response) +- [token](webApp.WebAppSetResourceMediaType.md#token) +- [verifyTls](webApp.WebAppSetResourceMediaType.md#verifytls) + +### Methods + +- [\_\_str\_\_](webApp.WebAppSetResourceMediaType.md#__str__) +- [body](webApp.WebAppSetResourceMediaType.md#body) +- [execute](webApp.WebAppSetResourceMediaType.md#execute) +- [format\_response](webApp.WebAppSetResourceMediaType.md#format_response) +- [gethttpsAgent](webApp.WebAppSetResourceMediaType.md#gethttpsagent) +- [headers](webApp.WebAppSetResourceMediaType.md#headers) +- [parse](webApp.WebAppSetResourceMediaType.md#parse) +- [request](webApp.WebAppSetResourceMediaType.md#request) +- [url](webApp.WebAppSetResourceMediaType.md#url) + +## Constructors + +### constructor + +• **new WebAppSetResourceMediaType**(`config`, `token`, `app_name`, `name`, `media_type`): [`WebAppSetResourceMediaType`](webApp.WebAppSetResourceMediaType.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `app_name` | `string` | +| `name` | `string` | +| `media_type` | `string` | + +#### Returns + +[`WebAppSetResourceMediaType`](webApp.WebAppSetResourceMediaType.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +webApp.ts:356 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`WebAppSetResourceMediaTypeResponse`](webApp.WebAppSetResourceMediaTypeResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`WebAppSetResourceMediaTypeResponse`](webApp.WebAppSetResourceMediaTypeResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +webApp.ts:362 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/webApp.WebAppSetResourceMediaTypeResponse.md b/docs/classes/webApp.WebAppSetResourceMediaTypeResponse.md new file mode 100644 index 0000000..85797c6 --- /dev/null +++ b/docs/classes/webApp.WebAppSetResourceMediaTypeResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppSetResourceMediaTypeResponse + +# Class: WebAppSetResourceMediaTypeResponse + +[webApp](../modules/webApp.md).WebAppSetResourceMediaTypeResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`WebAppSetResourceMediaTypeResponse`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppSetResourceMediaTypeResponse.md#constructor) + +### Properties + +- [error](webApp.WebAppSetResourceMediaTypeResponse.md#error) +- [id](webApp.WebAppSetResourceMediaTypeResponse.md#id) +- [kind](webApp.WebAppSetResourceMediaTypeResponse.md#kind) +- [result](webApp.WebAppSetResourceMediaTypeResponse.md#result) + +### Methods + +- [\_\_str\_\_](webApp.WebAppSetResourceMediaTypeResponse.md#__str__) +- [is\_error](webApp.WebAppSetResourceMediaTypeResponse.md#is_error) +- [parse](webApp.WebAppSetResourceMediaTypeResponse.md#parse) + +## Constructors + +### constructor + +• **new WebAppSetResourceMediaTypeResponse**(): [`WebAppSetResourceMediaTypeResponse`](webApp.WebAppSetResourceMediaTypeResponse.md) + +#### Returns + +[`WebAppSetResourceMediaTypeResponse`](webApp.WebAppSetResourceMediaTypeResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +webApp.ts:378 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +webApp.ts:377 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/webApp.WebAppSetResourceModificationTime.md b/docs/classes/webApp.WebAppSetResourceModificationTime.md new file mode 100644 index 0000000..3774b03 --- /dev/null +++ b/docs/classes/webApp.WebAppSetResourceModificationTime.md @@ -0,0 +1,385 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppSetResourceModificationTime + +# Class: WebAppSetResourceModificationTime + +[webApp](../modules/webApp.md).WebAppSetResourceModificationTime + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`WebAppSetResourceModificationTime`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppSetResourceModificationTime.md#constructor) + +### Properties + +- [address](webApp.WebAppSetResourceModificationTime.md#address) +- [method](webApp.WebAppSetResourceModificationTime.md#method) +- [params](webApp.WebAppSetResourceModificationTime.md#params) +- [plcCertificate](webApp.WebAppSetResourceModificationTime.md#plccertificate) +- [protocol](webApp.WebAppSetResourceModificationTime.md#protocol) +- [response](webApp.WebAppSetResourceModificationTime.md#response) +- [token](webApp.WebAppSetResourceModificationTime.md#token) +- [verifyTls](webApp.WebAppSetResourceModificationTime.md#verifytls) + +### Methods + +- [\_\_str\_\_](webApp.WebAppSetResourceModificationTime.md#__str__) +- [body](webApp.WebAppSetResourceModificationTime.md#body) +- [execute](webApp.WebAppSetResourceModificationTime.md#execute) +- [format\_response](webApp.WebAppSetResourceModificationTime.md#format_response) +- [gethttpsAgent](webApp.WebAppSetResourceModificationTime.md#gethttpsagent) +- [headers](webApp.WebAppSetResourceModificationTime.md#headers) +- [parse](webApp.WebAppSetResourceModificationTime.md#parse) +- [request](webApp.WebAppSetResourceModificationTime.md#request) +- [url](webApp.WebAppSetResourceModificationTime.md#url) + +## Constructors + +### constructor + +• **new WebAppSetResourceModificationTime**(`config`, `token`, `app_name`, `name`, `last_modified`): [`WebAppSetResourceModificationTime`](webApp.WebAppSetResourceModificationTime.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `app_name` | `string` | +| `name` | `string` | +| `last_modified` | `string` | + +#### Returns + +[`WebAppSetResourceModificationTime`](webApp.WebAppSetResourceModificationTime.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +webApp.ts:383 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`WebAppSetResourceModificationTimeResponse`](webApp.WebAppSetResourceModificationTimeResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`WebAppSetResourceModificationTimeResponse`](webApp.WebAppSetResourceModificationTimeResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +webApp.ts:389 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/webApp.WebAppSetResourceModificationTimeResponse.md b/docs/classes/webApp.WebAppSetResourceModificationTimeResponse.md new file mode 100644 index 0000000..9cc0dfa --- /dev/null +++ b/docs/classes/webApp.WebAppSetResourceModificationTimeResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppSetResourceModificationTimeResponse + +# Class: WebAppSetResourceModificationTimeResponse + +[webApp](../modules/webApp.md).WebAppSetResourceModificationTimeResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`WebAppSetResourceModificationTimeResponse`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppSetResourceModificationTimeResponse.md#constructor) + +### Properties + +- [error](webApp.WebAppSetResourceModificationTimeResponse.md#error) +- [id](webApp.WebAppSetResourceModificationTimeResponse.md#id) +- [kind](webApp.WebAppSetResourceModificationTimeResponse.md#kind) +- [result](webApp.WebAppSetResourceModificationTimeResponse.md#result) + +### Methods + +- [\_\_str\_\_](webApp.WebAppSetResourceModificationTimeResponse.md#__str__) +- [is\_error](webApp.WebAppSetResourceModificationTimeResponse.md#is_error) +- [parse](webApp.WebAppSetResourceModificationTimeResponse.md#parse) + +## Constructors + +### constructor + +• **new WebAppSetResourceModificationTimeResponse**(): [`WebAppSetResourceModificationTimeResponse`](webApp.WebAppSetResourceModificationTimeResponse.md) + +#### Returns + +[`WebAppSetResourceModificationTimeResponse`](webApp.WebAppSetResourceModificationTimeResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +webApp.ts:405 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +webApp.ts:404 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/webApp.WebAppSetResourceVisibility.md b/docs/classes/webApp.WebAppSetResourceVisibility.md new file mode 100644 index 0000000..cff434d --- /dev/null +++ b/docs/classes/webApp.WebAppSetResourceVisibility.md @@ -0,0 +1,385 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppSetResourceVisibility + +# Class: WebAppSetResourceVisibility + +[webApp](../modules/webApp.md).WebAppSetResourceVisibility + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`WebAppSetResourceVisibility`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppSetResourceVisibility.md#constructor) + +### Properties + +- [address](webApp.WebAppSetResourceVisibility.md#address) +- [method](webApp.WebAppSetResourceVisibility.md#method) +- [params](webApp.WebAppSetResourceVisibility.md#params) +- [plcCertificate](webApp.WebAppSetResourceVisibility.md#plccertificate) +- [protocol](webApp.WebAppSetResourceVisibility.md#protocol) +- [response](webApp.WebAppSetResourceVisibility.md#response) +- [token](webApp.WebAppSetResourceVisibility.md#token) +- [verifyTls](webApp.WebAppSetResourceVisibility.md#verifytls) + +### Methods + +- [\_\_str\_\_](webApp.WebAppSetResourceVisibility.md#__str__) +- [body](webApp.WebAppSetResourceVisibility.md#body) +- [execute](webApp.WebAppSetResourceVisibility.md#execute) +- [format\_response](webApp.WebAppSetResourceVisibility.md#format_response) +- [gethttpsAgent](webApp.WebAppSetResourceVisibility.md#gethttpsagent) +- [headers](webApp.WebAppSetResourceVisibility.md#headers) +- [parse](webApp.WebAppSetResourceVisibility.md#parse) +- [request](webApp.WebAppSetResourceVisibility.md#request) +- [url](webApp.WebAppSetResourceVisibility.md#url) + +## Constructors + +### constructor + +• **new WebAppSetResourceVisibility**(`config`, `token`, `app_name`, `name`, `visibility`): [`WebAppSetResourceVisibility`](webApp.WebAppSetResourceVisibility.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `app_name` | `string` | +| `name` | `string` | +| `visibility` | `string` | + +#### Returns + +[`WebAppSetResourceVisibility`](webApp.WebAppSetResourceVisibility.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +webApp.ts:411 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`WebAppSetResourceVisibilityResponse`](webApp.WebAppSetResourceVisibilityResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`WebAppSetResourceVisibilityResponse`](webApp.WebAppSetResourceVisibilityResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +webApp.ts:417 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/webApp.WebAppSetResourceVisibilityResponse.md b/docs/classes/webApp.WebAppSetResourceVisibilityResponse.md new file mode 100644 index 0000000..7ca37d4 --- /dev/null +++ b/docs/classes/webApp.WebAppSetResourceVisibilityResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppSetResourceVisibilityResponse + +# Class: WebAppSetResourceVisibilityResponse + +[webApp](../modules/webApp.md).WebAppSetResourceVisibilityResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`WebAppSetResourceVisibilityResponse`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppSetResourceVisibilityResponse.md#constructor) + +### Properties + +- [error](webApp.WebAppSetResourceVisibilityResponse.md#error) +- [id](webApp.WebAppSetResourceVisibilityResponse.md#id) +- [kind](webApp.WebAppSetResourceVisibilityResponse.md#kind) +- [result](webApp.WebAppSetResourceVisibilityResponse.md#result) + +### Methods + +- [\_\_str\_\_](webApp.WebAppSetResourceVisibilityResponse.md#__str__) +- [is\_error](webApp.WebAppSetResourceVisibilityResponse.md#is_error) +- [parse](webApp.WebAppSetResourceVisibilityResponse.md#parse) + +## Constructors + +### constructor + +• **new WebAppSetResourceVisibilityResponse**(): [`WebAppSetResourceVisibilityResponse`](webApp.WebAppSetResourceVisibilityResponse.md) + +#### Returns + +[`WebAppSetResourceVisibilityResponse`](webApp.WebAppSetResourceVisibilityResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +webApp.ts:433 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +webApp.ts:432 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/webApp.WebAppSetState.md b/docs/classes/webApp.WebAppSetState.md new file mode 100644 index 0000000..d506190 --- /dev/null +++ b/docs/classes/webApp.WebAppSetState.md @@ -0,0 +1,384 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppSetState + +# Class: WebAppSetState + +[webApp](../modules/webApp.md).WebAppSetState + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`WebAppSetState`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppSetState.md#constructor) + +### Properties + +- [address](webApp.WebAppSetState.md#address) +- [method](webApp.WebAppSetState.md#method) +- [params](webApp.WebAppSetState.md#params) +- [plcCertificate](webApp.WebAppSetState.md#plccertificate) +- [protocol](webApp.WebAppSetState.md#protocol) +- [response](webApp.WebAppSetState.md#response) +- [token](webApp.WebAppSetState.md#token) +- [verifyTls](webApp.WebAppSetState.md#verifytls) + +### Methods + +- [\_\_str\_\_](webApp.WebAppSetState.md#__str__) +- [body](webApp.WebAppSetState.md#body) +- [execute](webApp.WebAppSetState.md#execute) +- [format\_response](webApp.WebAppSetState.md#format_response) +- [gethttpsAgent](webApp.WebAppSetState.md#gethttpsagent) +- [headers](webApp.WebAppSetState.md#headers) +- [parse](webApp.WebAppSetState.md#parse) +- [request](webApp.WebAppSetState.md#request) +- [url](webApp.WebAppSetState.md#url) + +## Constructors + +### constructor + +• **new WebAppSetState**(`config`, `token`, `name`, `state`): [`WebAppSetState`](webApp.WebAppSetState.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `name` | `string` | +| `state` | `string` | + +#### Returns + +[`WebAppSetState`](webApp.WebAppSetState.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +webApp.ts:120 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`WebAppSetStateResponse`](webApp.WebAppSetStateResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`WebAppSetStateResponse`](webApp.WebAppSetStateResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +webApp.ts:127 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/webApp.WebAppSetStateResponse.md b/docs/classes/webApp.WebAppSetStateResponse.md new file mode 100644 index 0000000..42674a8 --- /dev/null +++ b/docs/classes/webApp.WebAppSetStateResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webApp](../modules/webApp.md) / WebAppSetStateResponse + +# Class: WebAppSetStateResponse + +[webApp](../modules/webApp.md).WebAppSetStateResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`WebAppSetStateResponse`** + +## Table of contents + +### Constructors + +- [constructor](webApp.WebAppSetStateResponse.md#constructor) + +### Properties + +- [error](webApp.WebAppSetStateResponse.md#error) +- [id](webApp.WebAppSetStateResponse.md#id) +- [kind](webApp.WebAppSetStateResponse.md#kind) +- [result](webApp.WebAppSetStateResponse.md#result) + +### Methods + +- [\_\_str\_\_](webApp.WebAppSetStateResponse.md#__str__) +- [is\_error](webApp.WebAppSetStateResponse.md#is_error) +- [parse](webApp.WebAppSetStateResponse.md#parse) + +## Constructors + +### constructor + +• **new WebAppSetStateResponse**(): [`WebAppSetStateResponse`](webApp.WebAppSetStateResponse.md) + +#### Returns + +[`WebAppSetStateResponse`](webApp.WebAppSetStateResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +webApp.ts:143 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +webApp.ts:142 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/webserver.WebServerReadDefaultPage.md b/docs/classes/webserver.WebServerReadDefaultPage.md new file mode 100644 index 0000000..a975ece --- /dev/null +++ b/docs/classes/webserver.WebServerReadDefaultPage.md @@ -0,0 +1,381 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webserver](../modules/webserver.md) / WebServerReadDefaultPage + +# Class: WebServerReadDefaultPage + +[webserver](../modules/webserver.md).WebServerReadDefaultPage + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`WebServerReadDefaultPage`** + +## Table of contents + +### Constructors + +- [constructor](webserver.WebServerReadDefaultPage.md#constructor) + +### Properties + +- [address](webserver.WebServerReadDefaultPage.md#address) +- [method](webserver.WebServerReadDefaultPage.md#method) +- [params](webserver.WebServerReadDefaultPage.md#params) +- [plcCertificate](webserver.WebServerReadDefaultPage.md#plccertificate) +- [protocol](webserver.WebServerReadDefaultPage.md#protocol) +- [response](webserver.WebServerReadDefaultPage.md#response) +- [token](webserver.WebServerReadDefaultPage.md#token) +- [verifyTls](webserver.WebServerReadDefaultPage.md#verifytls) + +### Methods + +- [\_\_str\_\_](webserver.WebServerReadDefaultPage.md#__str__) +- [body](webserver.WebServerReadDefaultPage.md#body) +- [execute](webserver.WebServerReadDefaultPage.md#execute) +- [format\_response](webserver.WebServerReadDefaultPage.md#format_response) +- [gethttpsAgent](webserver.WebServerReadDefaultPage.md#gethttpsagent) +- [headers](webserver.WebServerReadDefaultPage.md#headers) +- [parse](webserver.WebServerReadDefaultPage.md#parse) +- [request](webserver.WebServerReadDefaultPage.md#request) +- [url](webserver.WebServerReadDefaultPage.md#url) + +## Constructors + +### constructor + +• **new WebServerReadDefaultPage**(`config`): [`WebServerReadDefaultPage`](webserver.WebServerReadDefaultPage.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | + +#### Returns + +[`WebServerReadDefaultPage`](webserver.WebServerReadDefaultPage.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +webserver.ts:46 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`WebServerReadDefaultPageResponse`](webserver.WebServerReadDefaultPageResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`WebServerReadDefaultPageResponse`](webserver.WebServerReadDefaultPageResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +webserver.ts:52 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/webserver.WebServerReadDefaultPageResponse.md b/docs/classes/webserver.WebServerReadDefaultPageResponse.md new file mode 100644 index 0000000..28737c7 --- /dev/null +++ b/docs/classes/webserver.WebServerReadDefaultPageResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webserver](../modules/webserver.md) / WebServerReadDefaultPageResponse + +# Class: WebServerReadDefaultPageResponse + +[webserver](../modules/webserver.md).WebServerReadDefaultPageResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`WebServerReadDefaultPageResponse`** + +## Table of contents + +### Constructors + +- [constructor](webserver.WebServerReadDefaultPageResponse.md#constructor) + +### Properties + +- [error](webserver.WebServerReadDefaultPageResponse.md#error) +- [id](webserver.WebServerReadDefaultPageResponse.md#id) +- [kind](webserver.WebServerReadDefaultPageResponse.md#kind) +- [result](webserver.WebServerReadDefaultPageResponse.md#result) + +### Methods + +- [\_\_str\_\_](webserver.WebServerReadDefaultPageResponse.md#__str__) +- [is\_error](webserver.WebServerReadDefaultPageResponse.md#is_error) +- [parse](webserver.WebServerReadDefaultPageResponse.md#parse) + +## Constructors + +### constructor + +• **new WebServerReadDefaultPageResponse**(): [`WebServerReadDefaultPageResponse`](webserver.WebServerReadDefaultPageResponse.md) + +#### Returns + +[`WebServerReadDefaultPageResponse`](webserver.WebServerReadDefaultPageResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +webserver.ts:83 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `string` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +webserver.ts:81 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/classes/webserver.WebServerSetDefaultPage.md b/docs/classes/webserver.WebServerSetDefaultPage.md new file mode 100644 index 0000000..e8b0dd4 --- /dev/null +++ b/docs/classes/webserver.WebServerSetDefaultPage.md @@ -0,0 +1,383 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webserver](../modules/webserver.md) / WebServerSetDefaultPage + +# Class: WebServerSetDefaultPage + +[webserver](../modules/webserver.md).WebServerSetDefaultPage + +## Hierarchy + +- [`JsonrpcBaseRequest`](request.JsonrpcBaseRequest.md) + + ↳ **`WebServerSetDefaultPage`** + +## Table of contents + +### Constructors + +- [constructor](webserver.WebServerSetDefaultPage.md#constructor) + +### Properties + +- [address](webserver.WebServerSetDefaultPage.md#address) +- [method](webserver.WebServerSetDefaultPage.md#method) +- [params](webserver.WebServerSetDefaultPage.md#params) +- [plcCertificate](webserver.WebServerSetDefaultPage.md#plccertificate) +- [protocol](webserver.WebServerSetDefaultPage.md#protocol) +- [response](webserver.WebServerSetDefaultPage.md#response) +- [token](webserver.WebServerSetDefaultPage.md#token) +- [verifyTls](webserver.WebServerSetDefaultPage.md#verifytls) + +### Methods + +- [\_\_str\_\_](webserver.WebServerSetDefaultPage.md#__str__) +- [body](webserver.WebServerSetDefaultPage.md#body) +- [execute](webserver.WebServerSetDefaultPage.md#execute) +- [format\_response](webserver.WebServerSetDefaultPage.md#format_response) +- [gethttpsAgent](webserver.WebServerSetDefaultPage.md#gethttpsagent) +- [headers](webserver.WebServerSetDefaultPage.md#headers) +- [parse](webserver.WebServerSetDefaultPage.md#parse) +- [request](webserver.WebServerSetDefaultPage.md#request) +- [url](webserver.WebServerSetDefaultPage.md#url) + +## Constructors + +### constructor + +• **new WebServerSetDefaultPage**(`config`, `token`, `default_page`): [`WebServerSetDefaultPage`](webserver.WebServerSetDefaultPage.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`RequestConfig`](request.RequestConfig.md) | +| `token` | `string` | +| `default_page` | `string` | + +#### Returns + +[`WebServerSetDefaultPage`](webserver.WebServerSetDefaultPage.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[constructor](request.JsonrpcBaseRequest.md#constructor) + +#### Defined in + +webserver.ts:7 + +## Properties + +### address + +• **address**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[address](request.JsonrpcBaseRequest.md#address) + +#### Defined in + +request.ts:63 + +___ + +### method + +• `Optional` **method**: `string` + +Represents a base type for all jsonrpc requests against +the SIMATC S7 webserver +Provides all functions to build the request and execute it. + +**`Attribute`** + +method: defines the jsonrpc method and functions that are + defined for the WebAPI + +**`Attribute`** + +params: defines additional parameters required by the specific request methods + +**`Attribute`** + +address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + or the DNS name + Must not contain the protocol definition, this has to be set + via the protocol attribute + +**`Attribute`** + +protocol: defines the protocol (http/https) for connecting to the PLC + +**`Attribute`** + +token: Token for authentication and authorization on the PLC + +**`Attribute`** + +verifyTls: Switch wether TLS Server Certificate should be verified against + trusted certificates or trusted by default + +**`Attribute`** + +plcCertificate: File that contains the PLC certificate to be able to access the PLC. + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[method](request.JsonrpcBaseRequest.md#method) + +#### Defined in + +request.ts:61 + +___ + +### params + +• `Optional` **params**: `Record`\<`string`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[params](request.JsonrpcBaseRequest.md#params) + +#### Defined in + +request.ts:62 + +___ + +### plcCertificate + +• `Optional` **plcCertificate**: `Buffer` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[plcCertificate](request.JsonrpcBaseRequest.md#plccertificate) + +#### Defined in + +request.ts:68 + +___ + +### protocol + +• **protocol**: `string` = `''` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[protocol](request.JsonrpcBaseRequest.md#protocol) + +#### Defined in + +request.ts:64 + +___ + +### response + +• `Optional` **response**: `AxiosResponse`\<`any`, `any`\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[response](request.JsonrpcBaseRequest.md#response) + +#### Defined in + +request.ts:67 + +___ + +### token + +• `Optional` **token**: `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[token](request.JsonrpcBaseRequest.md#token) + +#### Defined in + +request.ts:65 + +___ + +### verifyTls + +• **verifyTls**: `boolean` = `true` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[verifyTls](request.JsonrpcBaseRequest.md#verifytls) + +#### Defined in + +request.ts:66 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[__str__](request.JsonrpcBaseRequest.md#__str__) + +#### Defined in + +request.ts:140 + +___ + +### body + +▸ **body**(): `undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Returns + +`undefined` \| ``null`` \| \{ `id`: `number` ; `jsonrpc`: `string` ; `method?`: `string` ; `params?`: `Record`\<`string`, `any`\> } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[body](request.JsonrpcBaseRequest.md#body) + +#### Defined in + +request.ts:107 + +___ + +### execute + +▸ **execute**(): `Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Returns + +`Promise`\<``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md)\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[execute](request.JsonrpcBaseRequest.md#execute) + +#### Defined in + +request.ts:162 + +___ + +### format\_response + +▸ **format_response**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[format_response](request.JsonrpcBaseRequest.md#format_response) + +#### Defined in + +request.ts:195 + +___ + +### gethttpsAgent + +▸ **gethttpsAgent**(): `undefined` \| `Agent` + +#### Returns + +`undefined` \| `Agent` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[gethttpsAgent](request.JsonrpcBaseRequest.md#gethttpsagent) + +#### Defined in + +request.ts:95 + +___ + +### headers + +▸ **headers**(): \{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Returns + +\{ `Content-type`: `string` = "application/json"; `X-Auth-Token`: `string` } \| \{ `Content-type`: `string` = "application/json"; `X-Auth-Token?`: `undefined` } + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[headers](request.JsonrpcBaseRequest.md#headers) + +#### Defined in + +request.ts:84 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`WebServerSetDefaultPageResponse`](webserver.WebServerSetDefaultPageResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) | + +#### Returns + +``null`` \| [`WebServerSetDefaultPageResponse`](webserver.WebServerSetDefaultPageResponse.md) + +#### Overrides + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[parse](request.JsonrpcBaseRequest.md#parse) + +#### Defined in + +webserver.ts:13 + +___ + +### request + +▸ **request**(): `Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Returns + +`Promise`\<`AxiosResponse`\<`any`, `any`\>\> + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[request](request.JsonrpcBaseRequest.md#request) + +#### Defined in + +request.ts:145 + +___ + +### url + +▸ **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseRequest](request.JsonrpcBaseRequest.md).[url](request.JsonrpcBaseRequest.md#url) + +#### Defined in + +request.ts:133 diff --git a/docs/classes/webserver.WebServerSetDefaultPageResponse.md b/docs/classes/webserver.WebServerSetDefaultPageResponse.md new file mode 100644 index 0000000..8cd876f --- /dev/null +++ b/docs/classes/webserver.WebServerSetDefaultPageResponse.md @@ -0,0 +1,174 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [webserver](../modules/webserver.md) / WebServerSetDefaultPageResponse + +# Class: WebServerSetDefaultPageResponse + +[webserver](../modules/webserver.md).WebServerSetDefaultPageResponse + +## Hierarchy + +- [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + + ↳ **`WebServerSetDefaultPageResponse`** + +## Table of contents + +### Constructors + +- [constructor](webserver.WebServerSetDefaultPageResponse.md#constructor) + +### Properties + +- [error](webserver.WebServerSetDefaultPageResponse.md#error) +- [id](webserver.WebServerSetDefaultPageResponse.md#id) +- [kind](webserver.WebServerSetDefaultPageResponse.md#kind) +- [result](webserver.WebServerSetDefaultPageResponse.md#result) + +### Methods + +- [\_\_str\_\_](webserver.WebServerSetDefaultPageResponse.md#__str__) +- [is\_error](webserver.WebServerSetDefaultPageResponse.md#is_error) +- [parse](webserver.WebServerSetDefaultPageResponse.md#parse) + +## Constructors + +### constructor + +• **new WebServerSetDefaultPageResponse**(): [`WebServerSetDefaultPageResponse`](webserver.WebServerSetDefaultPageResponse.md) + +#### Returns + +[`WebServerSetDefaultPageResponse`](webserver.WebServerSetDefaultPageResponse.md) + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[constructor](response.JsonrpcBaseResponse.md#constructor) + +#### Defined in + +webserver.ts:40 + +## Properties + +### error + +• `Optional` **error**: [`JsonrpcError`](response.JsonrpcError.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[error](response.JsonrpcBaseResponse.md#error) + +#### Defined in + +response.ts:55 + +___ + +### id + +• **id**: `number` = `0` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[id](response.JsonrpcBaseResponse.md#id) + +#### Defined in + +response.ts:54 + +___ + +### kind + +• `Optional` `Readonly` **kind**: `string` + +Base type for all responsed returned by the SIMATIC S7 Webserver + +**`Param`** + +Generic type for error if there is one, else None + +**`Param`** + +Object that provides result data + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[kind](response.JsonrpcBaseResponse.md#kind) + +#### Defined in + +response.ts:53 + +___ + +### result + +• `Optional` **result**: `boolean` + +#### Overrides + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[result](response.JsonrpcBaseResponse.md#result) + +#### Defined in + +webserver.ts:39 + +## Methods + +### \_\_str\_\_ + +▸ **__str__**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[__str__](response.JsonrpcBaseResponse.md#__str__) + +#### Defined in + +response.ts:128 + +___ + +### is\_error + +▸ **is_error**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[is_error](response.JsonrpcBaseResponse.md#is_error) + +#### Defined in + +response.ts:68 + +___ + +### parse + +▸ **parse**(`response`): ``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `AxiosResponse`\<`any`, `any`\> | + +#### Returns + +``null`` \| [`JsonrpcBaseResponse`](response.JsonrpcBaseResponse.md) + +#### Inherited from + +[JsonrpcBaseResponse](response.JsonrpcBaseResponse.md).[parse](response.JsonrpcBaseResponse.md#parse) + +#### Defined in + +response.ts:74 diff --git a/docs/enums/api.ApiTicketState.md b/docs/enums/api.ApiTicketState.md new file mode 100644 index 0000000..3442e62 --- /dev/null +++ b/docs/enums/api.ApiTicketState.md @@ -0,0 +1,54 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [api](../modules/api.md) / ApiTicketState + +# Enumeration: ApiTicketState + +[api](../modules/api.md).ApiTicketState + +## Table of contents + +### Enumeration Members + +- [ACTIVE](api.ApiTicketState.md#active) +- [COMPLETED](api.ApiTicketState.md#completed) +- [CREATED](api.ApiTicketState.md#created) +- [FAILED](api.ApiTicketState.md#failed) + +## Enumeration Members + +### ACTIVE + +• **ACTIVE** = ``"active"`` + +#### Defined in + +api.ts:8 + +___ + +### COMPLETED + +• **COMPLETED** = ``"completed"`` + +#### Defined in + +api.ts:9 + +___ + +### CREATED + +• **CREATED** = ``"created"`` + +#### Defined in + +api.ts:7 + +___ + +### FAILED + +• **FAILED** = ``"failed"`` + +#### Defined in + +api.ts:10 diff --git a/docs/enums/plc.PlcOpertingMode.md b/docs/enums/plc.PlcOpertingMode.md new file mode 100644 index 0000000..d9d5dd1 --- /dev/null +++ b/docs/enums/plc.PlcOpertingMode.md @@ -0,0 +1,65 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../modules.md) / [plc](../modules/plc.md) / PlcOpertingMode + +# Enumeration: PlcOpertingMode + +[plc](../modules/plc.md).PlcOpertingMode + +## Table of contents + +### Enumeration Members + +- [HOLD](plc.PlcOpertingMode.md#hold) +- [RUN](plc.PlcOpertingMode.md#run) +- [STARTUP](plc.PlcOpertingMode.md#startup) +- [STOP](plc.PlcOpertingMode.md#stop) +- [UNKNOWN](plc.PlcOpertingMode.md#unknown) + +## Enumeration Members + +### HOLD + +• **HOLD** = ``"hold"`` + +#### Defined in + +plc.ts:10 + +___ + +### RUN + +• **RUN** = ``"run"`` + +#### Defined in + +plc.ts:9 + +___ + +### STARTUP + +• **STARTUP** = ``"startup"`` + +#### Defined in + +plc.ts:8 + +___ + +### STOP + +• **STOP** = ``"stop"`` + +#### Defined in + +plc.ts:7 + +___ + +### UNKNOWN + +• **UNKNOWN** = ``""`` + +#### Defined in + +plc.ts:11 diff --git a/docs/modules.md b/docs/modules.md new file mode 100644 index 0000000..a1bcec4 --- /dev/null +++ b/docs/modules.md @@ -0,0 +1,24 @@ +[typescript-simatic-s7-webserver-api](README.md) / Exports + +# typescript-simatic-s7-webserver-api + +## Table of contents + +### Modules + +- [alarms](modules/alarms.md) +- [api](modules/api.md) +- [datalogs](modules/datalogs.md) +- [diagnosticbuffer](modules/diagnosticbuffer.md) +- [failsafe](modules/failsafe.md) +- [files](modules/files.md) +- [index](modules/index.md) +- [plc](modules/plc.md) +- [plcprogram](modules/plcprogram.md) +- [project](modules/project.md) +- [request](modules/request.md) +- [response](modules/response.md) +- [syslog](modules/syslog.md) +- [ticket](modules/ticket.md) +- [webApp](modules/webApp.md) +- [webserver](modules/webserver.md) diff --git a/docs/modules/alarms.md b/docs/modules/alarms.md new file mode 100644 index 0000000..b1d7b20 --- /dev/null +++ b/docs/modules/alarms.md @@ -0,0 +1,16 @@ +[typescript-simatic-s7-webserver-api](../../README.md) / [Exports](../modules.md) / alarms + +# Module: alarms + +## Table of contents + +### Classes + +- [Acknowledgement](../classes/alarms.Acknowledgement.md) +- [Alarms](../classes/alarms.Alarms.md) +- [AlarmsAcknowledge](../classes/alarms.AlarmsAcknowledge.md) +- [AlarmsAcknowledgeResponse](../classes/alarms.AlarmsAcknowledgeResponse.md) +- [AlarmsBrowse](../classes/alarms.AlarmsBrowse.md) +- [AlarmsBrowseResponse](../classes/alarms.AlarmsBrowseResponse.md) +- [EntryAlarm](../classes/alarms.EntryAlarm.md) +- [Filters](../classes/alarms.Filters.md) diff --git a/docs/modules/api.md b/docs/modules/api.md new file mode 100644 index 0000000..a520de8 --- /dev/null +++ b/docs/modules/api.md @@ -0,0 +1,42 @@ +[typescript-simatic-s7-webserver-api](../../README.md) / [Exports](../modules.md) / api + +# Module: api + +## Table of contents + +### Enumerations + +- [ApiTicketState](../enums/api.ApiTicketState.md) + +### Classes + +- [ApiBrowse](../classes/api.ApiBrowse.md) +- [ApiBrowseResponse](../classes/api.ApiBrowseResponse.md) +- [ApiBrowseTickets](../classes/api.ApiBrowseTickets.md) +- [ApiBrowseTicketsResponse](../classes/api.ApiBrowseTicketsResponse.md) +- [ApiChangePassword](../classes/api.ApiChangePassword.md) +- [ApiChangePasswordResponse](../classes/api.ApiChangePasswordResponse.md) +- [ApiCloseTickets](../classes/api.ApiCloseTickets.md) +- [ApiCloseTicketsResponse](../classes/api.ApiCloseTicketsResponse.md) +- [ApiGetAuthenticationMode](../classes/api.ApiGetAuthenticationMode.md) +- [ApiGetAuthenticationModeResponse](../classes/api.ApiGetAuthenticationModeResponse.md) +- [ApiGetCertificateUrl](../classes/api.ApiGetCertificateUrl.md) +- [ApiGetCertificateUrlResponse](../classes/api.ApiGetCertificateUrlResponse.md) +- [ApiGetPasswordPolicy](../classes/api.ApiGetPasswordPolicy.md) +- [ApiGetPasswordPolicyResponse](../classes/api.ApiGetPasswordPolicyResponse.md) +- [ApiGetPermissions](../classes/api.ApiGetPermissions.md) +- [ApiGetPermissionsResponse](../classes/api.ApiGetPermissionsResponse.md) +- [ApiGetQuantityStructures](../classes/api.ApiGetQuantityStructures.md) +- [ApiGetQuantityStructuresResponse](../classes/api.ApiGetQuantityStructuresResponse.md) +- [ApiLogin](../classes/api.ApiLogin.md) +- [ApiLoginResponse](../classes/api.ApiLoginResponse.md) +- [ApiLogout](../classes/api.ApiLogout.md) +- [ApiLogoutResponse](../classes/api.ApiLogoutResponse.md) +- [ApiPing](../classes/api.ApiPing.md) +- [ApiPingResponse](../classes/api.ApiPingResponse.md) +- [ApiTicket](../classes/api.ApiTicket.md) +- [ApiVersion](../classes/api.ApiVersion.md) +- [ApiVersionResponse](../classes/api.ApiVersionResponse.md) +- [CustomTicket](../classes/api.CustomTicket.md) +- [PasswordPolicy](../classes/api.PasswordPolicy.md) +- [QuantityStructure](../classes/api.QuantityStructure.md) diff --git a/docs/modules/datalogs.md b/docs/modules/datalogs.md new file mode 100644 index 0000000..d005a8b --- /dev/null +++ b/docs/modules/datalogs.md @@ -0,0 +1,10 @@ +[typescript-simatic-s7-webserver-api](../../README.md) / [Exports](../modules.md) / datalogs + +# Module: datalogs + +## Table of contents + +### Classes + +- [DataLogsDownloadAndClear](../classes/datalogs.DataLogsDownloadAndClear.md) +- [DataLogsDownloadAndClearResponse](../classes/datalogs.DataLogsDownloadAndClearResponse.md) diff --git a/docs/modules/diagnosticbuffer.md b/docs/modules/diagnosticbuffer.md new file mode 100644 index 0000000..e63d7fc --- /dev/null +++ b/docs/modules/diagnosticbuffer.md @@ -0,0 +1,14 @@ +[typescript-simatic-s7-webserver-api](../../README.md) / [Exports](../modules.md) / diagnosticbuffer + +# Module: diagnosticbuffer + +## Table of contents + +### Classes + +- [DiagnosticBufferBrowse](../classes/diagnosticbuffer.DiagnosticBufferBrowse.md) +- [DiagnosticBufferBrowseResponse](../classes/diagnosticbuffer.DiagnosticBufferBrowseResponse.md) +- [DiagnosticBufferStructure](../classes/diagnosticbuffer.DiagnosticBufferStructure.md) +- [Entry](../classes/diagnosticbuffer.Entry.md) +- [Event](../classes/diagnosticbuffer.Event.md) +- [Filters](../classes/diagnosticbuffer.Filters.md) diff --git a/docs/modules/failsafe.md b/docs/modules/failsafe.md new file mode 100644 index 0000000..b0a9ecf --- /dev/null +++ b/docs/modules/failsafe.md @@ -0,0 +1,16 @@ +[typescript-simatic-s7-webserver-api](../../README.md) / [Exports](../modules.md) / failsafe + +# Module: failsafe + +## Table of contents + +### Classes + +- [CPUResponse](../classes/failsafe.CPUResponse.md) +- [FailsafeReadParameters](../classes/failsafe.FailsafeReadParameters.md) +- [FailsafeReadParametersResponse](../classes/failsafe.FailsafeReadParametersResponse.md) +- [FailsafeReadParametersStructure](../classes/failsafe.FailsafeReadParametersStructure.md) +- [FailsafeReadRuntimeGroups](../classes/failsafe.FailsafeReadRuntimeGroups.md) +- [FailsafeReadRuntimeGroupsResponse](../classes/failsafe.FailsafeReadRuntimeGroupsResponse.md) +- [FailsafeReadRuntimeGroupsStructure](../classes/failsafe.FailsafeReadRuntimeGroupsStructure.md) +- [ModuleResponse](../classes/failsafe.ModuleResponse.md) diff --git a/docs/modules/files.md b/docs/modules/files.md new file mode 100644 index 0000000..1cfcf7f --- /dev/null +++ b/docs/modules/files.md @@ -0,0 +1,23 @@ +[typescript-simatic-s7-webserver-api](../../README.md) / [Exports](../modules.md) / files + +# Module: files + +## Table of contents + +### Classes + +- [FilesBrowse](../classes/files.FilesBrowse.md) +- [FilesBrowseResponse](../classes/files.FilesBrowseResponse.md) +- [FilesCreate](../classes/files.FilesCreate.md) +- [FilesCreateDirectory](../classes/files.FilesCreateDirectory.md) +- [FilesCreateDirectoryResponse](../classes/files.FilesCreateDirectoryResponse.md) +- [FilesCreateResponse](../classes/files.FilesCreateResponse.md) +- [FilesDelete](../classes/files.FilesDelete.md) +- [FilesDeleteDirectory](../classes/files.FilesDeleteDirectory.md) +- [FilesDeleteDirectoryResponse](../classes/files.FilesDeleteDirectoryResponse.md) +- [FilesDeleteResponse](../classes/files.FilesDeleteResponse.md) +- [FilesDownload](../classes/files.FilesDownload.md) +- [FilesDownloadResponse](../classes/files.FilesDownloadResponse.md) +- [FilesRename](../classes/files.FilesRename.md) +- [FilesRenameResponse](../classes/files.FilesRenameResponse.md) +- [Resources](../classes/files.Resources.md) diff --git a/docs/modules/index.md b/docs/modules/index.md new file mode 100644 index 0000000..1a01549 --- /dev/null +++ b/docs/modules/index.md @@ -0,0 +1,1121 @@ +[typescript-simatic-s7-webserver-api](../../README.md) / [Exports](../modules.md) / index + +# Module: index + +## Table of contents + +### References + +- [Acknowledgement](index.md#acknowledgement) +- [Alarms](index.md#alarms) +- [AlarmsAcknowledge](index.md#alarmsacknowledge) +- [AlarmsAcknowledgeResponse](index.md#alarmsacknowledgeresponse) +- [AlarmsBrowse](index.md#alarmsbrowse) +- [AlarmsBrowseResponse](index.md#alarmsbrowseresponse) +- [ApiBrowse](index.md#apibrowse) +- [ApiBrowseResponse](index.md#apibrowseresponse) +- [ApiBrowseTickets](index.md#apibrowsetickets) +- [ApiBrowseTicketsResponse](index.md#apibrowseticketsresponse) +- [ApiChangePassword](index.md#apichangepassword) +- [ApiChangePasswordResponse](index.md#apichangepasswordresponse) +- [ApiCloseTickets](index.md#apiclosetickets) +- [ApiCloseTicketsResponse](index.md#apicloseticketsresponse) +- [ApiGetAuthenticationMode](index.md#apigetauthenticationmode) +- [ApiGetAuthenticationModeResponse](index.md#apigetauthenticationmoderesponse) +- [ApiGetCertificateUrl](index.md#apigetcertificateurl) +- [ApiGetCertificateUrlResponse](index.md#apigetcertificateurlresponse) +- [ApiGetPasswordPolicy](index.md#apigetpasswordpolicy) +- [ApiGetPasswordPolicyResponse](index.md#apigetpasswordpolicyresponse) +- [ApiGetPermissions](index.md#apigetpermissions) +- [ApiGetPermissionsResponse](index.md#apigetpermissionsresponse) +- [ApiGetQuantityStructures](index.md#apigetquantitystructures) +- [ApiGetQuantityStructuresResponse](index.md#apigetquantitystructuresresponse) +- [ApiLogin](index.md#apilogin) +- [ApiLoginResponse](index.md#apiloginresponse) +- [ApiLogout](index.md#apilogout) +- [ApiLogoutResponse](index.md#apilogoutresponse) +- [ApiPing](index.md#apiping) +- [ApiPingResponse](index.md#apipingresponse) +- [ApiTicket](index.md#apiticket) +- [ApiTicketState](index.md#apiticketstate) +- [ApiVersion](index.md#apiversion) +- [ApiVersionResponse](index.md#apiversionresponse) +- [Application](index.md#application) +- [BrowseResourcesStructure](index.md#browseresourcesstructure) +- [BrowseStructure](index.md#browsestructure) +- [CPUResponse](index.md#cpuresponse) +- [CustomTicket](index.md#customticket) +- [DataLogsDownloadAndClear](index.md#datalogsdownloadandclear) +- [DataLogsDownloadAndClearResponse](index.md#datalogsdownloadandclearresponse) +- [DiagnosticBufferBrowse](index.md#diagnosticbufferbrowse) +- [DiagnosticBufferBrowseResponse](index.md#diagnosticbufferbrowseresponse) +- [DiagnosticBufferStructure](index.md#diagnosticbufferstructure) +- [Entry](index.md#entry) +- [EntryAlarm](index.md#entryalarm) +- [Event](index.md#event) +- [FailsafeReadParameters](index.md#failsafereadparameters) +- [FailsafeReadParametersResponse](index.md#failsafereadparametersresponse) +- [FailsafeReadParametersStructure](index.md#failsafereadparametersstructure) +- [FailsafeReadRuntimeGroups](index.md#failsafereadruntimegroups) +- [FailsafeReadRuntimeGroupsResponse](index.md#failsafereadruntimegroupsresponse) +- [FailsafeReadRuntimeGroupsStructure](index.md#failsafereadruntimegroupsstructure) +- [FilesBrowse](index.md#filesbrowse) +- [FilesBrowseResponse](index.md#filesbrowseresponse) +- [FilesCreate](index.md#filescreate) +- [FilesCreateDirectory](index.md#filescreatedirectory) +- [FilesCreateDirectoryResponse](index.md#filescreatedirectoryresponse) +- [FilesCreateResponse](index.md#filescreateresponse) +- [FilesDelete](index.md#filesdelete) +- [FilesDeleteDirectory](index.md#filesdeletedirectory) +- [FilesDeleteDirectoryResponse](index.md#filesdeletedirectoryresponse) +- [FilesDeleteResponse](index.md#filesdeleteresponse) +- [FilesDownload](index.md#filesdownload) +- [FilesDownloadResponse](index.md#filesdownloadresponse) +- [FilesRename](index.md#filesrename) +- [FilesRenameResponse](index.md#filesrenameresponse) +- [Filters](index.md#filters) +- [JsonrpcBaseRequest](index.md#jsonrpcbaserequest) +- [JsonrpcBaseResponse](index.md#jsonrpcbaseresponse) +- [JsonrpcError](index.md#jsonrpcerror) +- [Languages](index.md#languages) +- [ModuleResponse](index.md#moduleresponse) +- [PasswordPolicy](index.md#passwordpolicy) +- [PlcCreateBackup](index.md#plccreatebackup) +- [PlcCreateBackupResponse](index.md#plccreatebackupresponse) +- [PlcOpertingMode](index.md#plcopertingmode) +- [PlcProgramBrowse](index.md#plcprogrambrowse) +- [PlcProgramBrowseArrayData](index.md#plcprogrambrowsearraydata) +- [PlcProgramBrowseResponse](index.md#plcprogrambrowseresponse) +- [PlcProgramBrowseVariable](index.md#plcprogrambrowsevariable) +- [PlcProgramDownloadProfilingData](index.md#plcprogramdownloadprofilingdata) +- [PlcProgramDownloadProfilingDataResponse](index.md#plcprogramdownloadprofilingdataresponse) +- [PlcProgramRead](index.md#plcprogramread) +- [PlcProgramReadResponse](index.md#plcprogramreadresponse) +- [PlcProgramWrite](index.md#plcprogramwrite) +- [PlcProgramWriteResponse](index.md#plcprogramwriteresponse) +- [PlcReadOperatingMode](index.md#plcreadoperatingmode) +- [PlcReadOperatingModeResponse](index.md#plcreadoperatingmoderesponse) +- [PlcReadSystemTime](index.md#plcreadsystemtime) +- [PlcReadSystemTimeResponse](index.md#plcreadsystemtimeresponse) +- [PlcReadTimeSettings](index.md#plcreadtimesettings) +- [PlcReadTimeSettingsResponse](index.md#plcreadtimesettingsresponse) +- [PlcRequestChangeOperatingMode](index.md#plcrequestchangeoperatingmode) +- [PlcRequestChangeOperatingModeResponse](index.md#plcrequestchangeoperatingmoderesponse) +- [PlcRestoreBackup](index.md#plcrestorebackup) +- [PlcRestoreBackupResponse](index.md#plcrestorebackupresponse) +- [PlcSetSystemTime](index.md#plcsetsystemtime) +- [PlcSetSystemTimeResponse](index.md#plcsetsystemtimeresponse) +- [PlcSetTimeSettings](index.md#plcsettimesettings) +- [PlcSetTimeSettingsResponse](index.md#plcsettimesettingsresponse) +- [ProjectLanguages](index.md#projectlanguages) +- [ProjectLanguagesResponse](index.md#projectlanguagesresponse) +- [ProxyTicketDownloadData](index.md#proxyticketdownloaddata) +- [ProxyTicketUploadData](index.md#proxyticketuploaddata) +- [QuantityStructure](index.md#quantitystructure) +- [RequestConfig](index.md#requestconfig) +- [Resource](index.md#resource) +- [Resources](index.md#resources) +- [Rule](index.md#rule) +- [RuleDst](index.md#ruledst) +- [RuleStart](index.md#rulestart) +- [RuleStd](index.md#rulestd) +- [SyslogBrowse](index.md#syslogbrowse) +- [SyslogBrowseResponse](index.md#syslogbrowseresponse) +- [SyslogBrowseStructure](index.md#syslogbrowsestructure) +- [SyslogData](index.md#syslogdata) +- [TicketDownloadData](index.md#ticketdownloaddata) +- [TicketUploadData](index.md#ticketuploaddata) +- [TimeSettings](index.md#timesettings) +- [WebAppBrowse](index.md#webappbrowse) +- [WebAppBrowseResources](index.md#webappbrowseresources) +- [WebAppBrowseResourcesResponse](index.md#webappbrowseresourcesresponse) +- [WebAppBrowseResponse](index.md#webappbrowseresponse) +- [WebAppCreate](index.md#webappcreate) +- [WebAppCreateResource](index.md#webappcreateresource) +- [WebAppCreateResourceResponse](index.md#webappcreateresourceresponse) +- [WebAppCreateResponse](index.md#webappcreateresponse) +- [WebAppDelete](index.md#webappdelete) +- [WebAppDeleteResource](index.md#webappdeleteresource) +- [WebAppDeleteResourceResponse](index.md#webappdeleteresourceresponse) +- [WebAppDeleteResponse](index.md#webappdeleteresponse) +- [WebAppDownloadResource](index.md#webappdownloadresource) +- [WebAppDownloadResourceResponse](index.md#webappdownloadresourceresponse) +- [WebAppRename](index.md#webapprename) +- [WebAppRenameResource](index.md#webapprenameresource) +- [WebAppRenameResourceResponse](index.md#webapprenameresourceresponse) +- [WebAppRenameResponse](index.md#webapprenameresponse) +- [WebAppSetDefaultPage](index.md#webappsetdefaultpage) +- [WebAppSetDefaultPageResponse](index.md#webappsetdefaultpageresponse) +- [WebAppSetNotAuthorizedPage](index.md#webappsetnotauthorizedpage) +- [WebAppSetNotAuthorizedPageResponse](index.md#webappsetnotauthorizedpageresponse) +- [WebAppSetNotFoundPage](index.md#webappsetnotfoundpage) +- [WebAppSetNotFoundPageResponse](index.md#webappsetnotfoundpageresponse) +- [WebAppSetResourceETag](index.md#webappsetresourceetag) +- [WebAppSetResourceETagResponse](index.md#webappsetresourceetagresponse) +- [WebAppSetResourceMediaType](index.md#webappsetresourcemediatype) +- [WebAppSetResourceMediaTypeResponse](index.md#webappsetresourcemediatyperesponse) +- [WebAppSetResourceModificationTime](index.md#webappsetresourcemodificationtime) +- [WebAppSetResourceModificationTimeResponse](index.md#webappsetresourcemodificationtimeresponse) +- [WebAppSetResourceVisibility](index.md#webappsetresourcevisibility) +- [WebAppSetResourceVisibilityResponse](index.md#webappsetresourcevisibilityresponse) +- [WebAppSetState](index.md#webappsetstate) +- [WebAppSetStateResponse](index.md#webappsetstateresponse) +- [WebServerReadDefaultPage](index.md#webserverreaddefaultpage) +- [WebServerReadDefaultPageResponse](index.md#webserverreaddefaultpageresponse) +- [WebServerSetDefaultPage](index.md#webserversetdefaultpage) +- [WebServerSetDefaultPageResponse](index.md#webserversetdefaultpageresponse) +- [obtainEnumValue](index.md#obtainenumvalue) + +## References + +### Acknowledgement + +Re-exports [Acknowledgement](../classes/alarms.Acknowledgement.md) + +___ + +### Alarms + +Re-exports [Alarms](../classes/alarms.Alarms.md) + +___ + +### AlarmsAcknowledge + +Re-exports [AlarmsAcknowledge](../classes/alarms.AlarmsAcknowledge.md) + +___ + +### AlarmsAcknowledgeResponse + +Re-exports [AlarmsAcknowledgeResponse](../classes/alarms.AlarmsAcknowledgeResponse.md) + +___ + +### AlarmsBrowse + +Re-exports [AlarmsBrowse](../classes/alarms.AlarmsBrowse.md) + +___ + +### AlarmsBrowseResponse + +Re-exports [AlarmsBrowseResponse](../classes/alarms.AlarmsBrowseResponse.md) + +___ + +### ApiBrowse + +Re-exports [ApiBrowse](../classes/api.ApiBrowse.md) + +___ + +### ApiBrowseResponse + +Re-exports [ApiBrowseResponse](../classes/api.ApiBrowseResponse.md) + +___ + +### ApiBrowseTickets + +Re-exports [ApiBrowseTickets](../classes/api.ApiBrowseTickets.md) + +___ + +### ApiBrowseTicketsResponse + +Re-exports [ApiBrowseTicketsResponse](../classes/api.ApiBrowseTicketsResponse.md) + +___ + +### ApiChangePassword + +Re-exports [ApiChangePassword](../classes/api.ApiChangePassword.md) + +___ + +### ApiChangePasswordResponse + +Re-exports [ApiChangePasswordResponse](../classes/api.ApiChangePasswordResponse.md) + +___ + +### ApiCloseTickets + +Re-exports [ApiCloseTickets](../classes/api.ApiCloseTickets.md) + +___ + +### ApiCloseTicketsResponse + +Re-exports [ApiCloseTicketsResponse](../classes/api.ApiCloseTicketsResponse.md) + +___ + +### ApiGetAuthenticationMode + +Re-exports [ApiGetAuthenticationMode](../classes/api.ApiGetAuthenticationMode.md) + +___ + +### ApiGetAuthenticationModeResponse + +Re-exports [ApiGetAuthenticationModeResponse](../classes/api.ApiGetAuthenticationModeResponse.md) + +___ + +### ApiGetCertificateUrl + +Re-exports [ApiGetCertificateUrl](../classes/api.ApiGetCertificateUrl.md) + +___ + +### ApiGetCertificateUrlResponse + +Re-exports [ApiGetCertificateUrlResponse](../classes/api.ApiGetCertificateUrlResponse.md) + +___ + +### ApiGetPasswordPolicy + +Re-exports [ApiGetPasswordPolicy](../classes/api.ApiGetPasswordPolicy.md) + +___ + +### ApiGetPasswordPolicyResponse + +Re-exports [ApiGetPasswordPolicyResponse](../classes/api.ApiGetPasswordPolicyResponse.md) + +___ + +### ApiGetPermissions + +Re-exports [ApiGetPermissions](../classes/api.ApiGetPermissions.md) + +___ + +### ApiGetPermissionsResponse + +Re-exports [ApiGetPermissionsResponse](../classes/api.ApiGetPermissionsResponse.md) + +___ + +### ApiGetQuantityStructures + +Re-exports [ApiGetQuantityStructures](../classes/api.ApiGetQuantityStructures.md) + +___ + +### ApiGetQuantityStructuresResponse + +Re-exports [ApiGetQuantityStructuresResponse](../classes/api.ApiGetQuantityStructuresResponse.md) + +___ + +### ApiLogin + +Re-exports [ApiLogin](../classes/api.ApiLogin.md) + +___ + +### ApiLoginResponse + +Re-exports [ApiLoginResponse](../classes/api.ApiLoginResponse.md) + +___ + +### ApiLogout + +Re-exports [ApiLogout](../classes/api.ApiLogout.md) + +___ + +### ApiLogoutResponse + +Re-exports [ApiLogoutResponse](../classes/api.ApiLogoutResponse.md) + +___ + +### ApiPing + +Re-exports [ApiPing](../classes/api.ApiPing.md) + +___ + +### ApiPingResponse + +Re-exports [ApiPingResponse](../classes/api.ApiPingResponse.md) + +___ + +### ApiTicket + +Re-exports [ApiTicket](../classes/api.ApiTicket.md) + +___ + +### ApiTicketState + +Re-exports [ApiTicketState](../enums/api.ApiTicketState.md) + +___ + +### ApiVersion + +Re-exports [ApiVersion](../classes/api.ApiVersion.md) + +___ + +### ApiVersionResponse + +Re-exports [ApiVersionResponse](../classes/api.ApiVersionResponse.md) + +___ + +### Application + +Re-exports [Application](../classes/webApp.Application.md) + +___ + +### BrowseResourcesStructure + +Re-exports [BrowseResourcesStructure](../classes/webApp.BrowseResourcesStructure.md) + +___ + +### BrowseStructure + +Re-exports [BrowseStructure](../classes/webApp.BrowseStructure.md) + +___ + +### CPUResponse + +Re-exports [CPUResponse](../classes/failsafe.CPUResponse.md) + +___ + +### CustomTicket + +Re-exports [CustomTicket](../classes/api.CustomTicket.md) + +___ + +### DataLogsDownloadAndClear + +Re-exports [DataLogsDownloadAndClear](../classes/datalogs.DataLogsDownloadAndClear.md) + +___ + +### DataLogsDownloadAndClearResponse + +Re-exports [DataLogsDownloadAndClearResponse](../classes/datalogs.DataLogsDownloadAndClearResponse.md) + +___ + +### DiagnosticBufferBrowse + +Re-exports [DiagnosticBufferBrowse](../classes/diagnosticbuffer.DiagnosticBufferBrowse.md) + +___ + +### DiagnosticBufferBrowseResponse + +Re-exports [DiagnosticBufferBrowseResponse](../classes/diagnosticbuffer.DiagnosticBufferBrowseResponse.md) + +___ + +### DiagnosticBufferStructure + +Re-exports [DiagnosticBufferStructure](../classes/diagnosticbuffer.DiagnosticBufferStructure.md) + +___ + +### Entry + +Re-exports [Entry](../classes/diagnosticbuffer.Entry.md) + +___ + +### EntryAlarm + +Re-exports [EntryAlarm](../classes/alarms.EntryAlarm.md) + +___ + +### Event + +Re-exports [Event](../classes/diagnosticbuffer.Event.md) + +___ + +### FailsafeReadParameters + +Re-exports [FailsafeReadParameters](../classes/failsafe.FailsafeReadParameters.md) + +___ + +### FailsafeReadParametersResponse + +Re-exports [FailsafeReadParametersResponse](../classes/failsafe.FailsafeReadParametersResponse.md) + +___ + +### FailsafeReadParametersStructure + +Re-exports [FailsafeReadParametersStructure](../classes/failsafe.FailsafeReadParametersStructure.md) + +___ + +### FailsafeReadRuntimeGroups + +Re-exports [FailsafeReadRuntimeGroups](../classes/failsafe.FailsafeReadRuntimeGroups.md) + +___ + +### FailsafeReadRuntimeGroupsResponse + +Re-exports [FailsafeReadRuntimeGroupsResponse](../classes/failsafe.FailsafeReadRuntimeGroupsResponse.md) + +___ + +### FailsafeReadRuntimeGroupsStructure + +Re-exports [FailsafeReadRuntimeGroupsStructure](../classes/failsafe.FailsafeReadRuntimeGroupsStructure.md) + +___ + +### FilesBrowse + +Re-exports [FilesBrowse](../classes/files.FilesBrowse.md) + +___ + +### FilesBrowseResponse + +Re-exports [FilesBrowseResponse](../classes/files.FilesBrowseResponse.md) + +___ + +### FilesCreate + +Re-exports [FilesCreate](../classes/files.FilesCreate.md) + +___ + +### FilesCreateDirectory + +Re-exports [FilesCreateDirectory](../classes/files.FilesCreateDirectory.md) + +___ + +### FilesCreateDirectoryResponse + +Re-exports [FilesCreateDirectoryResponse](../classes/files.FilesCreateDirectoryResponse.md) + +___ + +### FilesCreateResponse + +Re-exports [FilesCreateResponse](../classes/files.FilesCreateResponse.md) + +___ + +### FilesDelete + +Re-exports [FilesDelete](../classes/files.FilesDelete.md) + +___ + +### FilesDeleteDirectory + +Re-exports [FilesDeleteDirectory](../classes/files.FilesDeleteDirectory.md) + +___ + +### FilesDeleteDirectoryResponse + +Re-exports [FilesDeleteDirectoryResponse](../classes/files.FilesDeleteDirectoryResponse.md) + +___ + +### FilesDeleteResponse + +Re-exports [FilesDeleteResponse](../classes/files.FilesDeleteResponse.md) + +___ + +### FilesDownload + +Re-exports [FilesDownload](../classes/files.FilesDownload.md) + +___ + +### FilesDownloadResponse + +Re-exports [FilesDownloadResponse](../classes/files.FilesDownloadResponse.md) + +___ + +### FilesRename + +Re-exports [FilesRename](../classes/files.FilesRename.md) + +___ + +### FilesRenameResponse + +Re-exports [FilesRenameResponse](../classes/files.FilesRenameResponse.md) + +___ + +### Filters + +Re-exports [Filters](../classes/alarms.Filters.md) + +___ + +### JsonrpcBaseRequest + +Re-exports [JsonrpcBaseRequest](../classes/request.JsonrpcBaseRequest.md) + +___ + +### JsonrpcBaseResponse + +Re-exports [JsonrpcBaseResponse](../classes/response.JsonrpcBaseResponse.md) + +___ + +### JsonrpcError + +Re-exports [JsonrpcError](../classes/response.JsonrpcError.md) + +___ + +### Languages + +Re-exports [Languages](../classes/project.Languages.md) + +___ + +### ModuleResponse + +Re-exports [ModuleResponse](../classes/failsafe.ModuleResponse.md) + +___ + +### PasswordPolicy + +Re-exports [PasswordPolicy](../classes/api.PasswordPolicy.md) + +___ + +### PlcCreateBackup + +Re-exports [PlcCreateBackup](../classes/plc.PlcCreateBackup.md) + +___ + +### PlcCreateBackupResponse + +Re-exports [PlcCreateBackupResponse](../classes/plc.PlcCreateBackupResponse.md) + +___ + +### PlcOpertingMode + +Re-exports [PlcOpertingMode](../enums/plc.PlcOpertingMode.md) + +___ + +### PlcProgramBrowse + +Re-exports [PlcProgramBrowse](../classes/plcprogram.PlcProgramBrowse.md) + +___ + +### PlcProgramBrowseArrayData + +Re-exports [PlcProgramBrowseArrayData](../classes/plcprogram.PlcProgramBrowseArrayData.md) + +___ + +### PlcProgramBrowseResponse + +Re-exports [PlcProgramBrowseResponse](../classes/plcprogram.PlcProgramBrowseResponse.md) + +___ + +### PlcProgramBrowseVariable + +Re-exports [PlcProgramBrowseVariable](../classes/plcprogram.PlcProgramBrowseVariable.md) + +___ + +### PlcProgramDownloadProfilingData + +Re-exports [PlcProgramDownloadProfilingData](../classes/plcprogram.PlcProgramDownloadProfilingData.md) + +___ + +### PlcProgramDownloadProfilingDataResponse + +Re-exports [PlcProgramDownloadProfilingDataResponse](../classes/plcprogram.PlcProgramDownloadProfilingDataResponse.md) + +___ + +### PlcProgramRead + +Re-exports [PlcProgramRead](../classes/plcprogram.PlcProgramRead.md) + +___ + +### PlcProgramReadResponse + +Re-exports [PlcProgramReadResponse](../classes/plcprogram.PlcProgramReadResponse.md) + +___ + +### PlcProgramWrite + +Re-exports [PlcProgramWrite](../classes/plcprogram.PlcProgramWrite.md) + +___ + +### PlcProgramWriteResponse + +Re-exports [PlcProgramWriteResponse](../classes/plcprogram.PlcProgramWriteResponse.md) + +___ + +### PlcReadOperatingMode + +Re-exports [PlcReadOperatingMode](../classes/plc.PlcReadOperatingMode.md) + +___ + +### PlcReadOperatingModeResponse + +Re-exports [PlcReadOperatingModeResponse](../classes/plc.PlcReadOperatingModeResponse.md) + +___ + +### PlcReadSystemTime + +Re-exports [PlcReadSystemTime](../classes/plc.PlcReadSystemTime.md) + +___ + +### PlcReadSystemTimeResponse + +Re-exports [PlcReadSystemTimeResponse](../classes/plc.PlcReadSystemTimeResponse.md) + +___ + +### PlcReadTimeSettings + +Re-exports [PlcReadTimeSettings](../classes/plc.PlcReadTimeSettings.md) + +___ + +### PlcReadTimeSettingsResponse + +Re-exports [PlcReadTimeSettingsResponse](../classes/plc.PlcReadTimeSettingsResponse.md) + +___ + +### PlcRequestChangeOperatingMode + +Re-exports [PlcRequestChangeOperatingMode](../classes/plc.PlcRequestChangeOperatingMode.md) + +___ + +### PlcRequestChangeOperatingModeResponse + +Re-exports [PlcRequestChangeOperatingModeResponse](../classes/plc.PlcRequestChangeOperatingModeResponse.md) + +___ + +### PlcRestoreBackup + +Re-exports [PlcRestoreBackup](../classes/plc.PlcRestoreBackup.md) + +___ + +### PlcRestoreBackupResponse + +Re-exports [PlcRestoreBackupResponse](../classes/plc.PlcRestoreBackupResponse.md) + +___ + +### PlcSetSystemTime + +Re-exports [PlcSetSystemTime](../classes/plc.PlcSetSystemTime.md) + +___ + +### PlcSetSystemTimeResponse + +Re-exports [PlcSetSystemTimeResponse](../classes/plc.PlcSetSystemTimeResponse.md) + +___ + +### PlcSetTimeSettings + +Re-exports [PlcSetTimeSettings](../classes/plc.PlcSetTimeSettings.md) + +___ + +### PlcSetTimeSettingsResponse + +Re-exports [PlcSetTimeSettingsResponse](../classes/plc.PlcSetTimeSettingsResponse.md) + +___ + +### ProjectLanguages + +Re-exports [ProjectLanguages](../classes/project.ProjectLanguages.md) + +___ + +### ProjectLanguagesResponse + +Re-exports [ProjectLanguagesResponse](../classes/project.ProjectLanguagesResponse.md) + +___ + +### ProxyTicketDownloadData + +Re-exports [ProxyTicketDownloadData](../classes/ticket.ProxyTicketDownloadData.md) + +___ + +### ProxyTicketUploadData + +Re-exports [ProxyTicketUploadData](../classes/ticket.ProxyTicketUploadData.md) + +___ + +### QuantityStructure + +Re-exports [QuantityStructure](../classes/api.QuantityStructure.md) + +___ + +### RequestConfig + +Re-exports [RequestConfig](../classes/request.RequestConfig.md) + +___ + +### Resource + +Re-exports [Resource](../classes/webApp.Resource.md) + +___ + +### Resources + +Re-exports [Resources](../classes/files.Resources.md) + +___ + +### Rule + +Re-exports [Rule](../classes/plc.Rule.md) + +___ + +### RuleDst + +Re-exports [RuleDst](../classes/plc.RuleDst.md) + +___ + +### RuleStart + +Re-exports [RuleStart](../classes/plc.RuleStart.md) + +___ + +### RuleStd + +Re-exports [RuleStd](../classes/plc.RuleStd.md) + +___ + +### SyslogBrowse + +Re-exports [SyslogBrowse](../classes/syslog.SyslogBrowse.md) + +___ + +### SyslogBrowseResponse + +Re-exports [SyslogBrowseResponse](../classes/syslog.SyslogBrowseResponse.md) + +___ + +### SyslogBrowseStructure + +Re-exports [SyslogBrowseStructure](../classes/syslog.SyslogBrowseStructure.md) + +___ + +### SyslogData + +Re-exports [SyslogData](../classes/syslog.SyslogData.md) + +___ + +### TicketDownloadData + +Re-exports [TicketDownloadData](../classes/ticket.TicketDownloadData.md) + +___ + +### TicketUploadData + +Re-exports [TicketUploadData](../classes/ticket.TicketUploadData.md) + +___ + +### TimeSettings + +Re-exports [TimeSettings](../classes/plc.TimeSettings.md) + +___ + +### WebAppBrowse + +Re-exports [WebAppBrowse](../classes/webApp.WebAppBrowse.md) + +___ + +### WebAppBrowseResources + +Re-exports [WebAppBrowseResources](../classes/webApp.WebAppBrowseResources.md) + +___ + +### WebAppBrowseResourcesResponse + +Re-exports [WebAppBrowseResourcesResponse](../classes/webApp.WebAppBrowseResourcesResponse.md) + +___ + +### WebAppBrowseResponse + +Re-exports [WebAppBrowseResponse](../classes/webApp.WebAppBrowseResponse.md) + +___ + +### WebAppCreate + +Re-exports [WebAppCreate](../classes/webApp.WebAppCreate.md) + +___ + +### WebAppCreateResource + +Re-exports [WebAppCreateResource](../classes/webApp.WebAppCreateResource.md) + +___ + +### WebAppCreateResourceResponse + +Re-exports [WebAppCreateResourceResponse](../classes/webApp.WebAppCreateResourceResponse.md) + +___ + +### WebAppCreateResponse + +Re-exports [WebAppCreateResponse](../classes/webApp.WebAppCreateResponse.md) + +___ + +### WebAppDelete + +Re-exports [WebAppDelete](../classes/webApp.WebAppDelete.md) + +___ + +### WebAppDeleteResource + +Re-exports [WebAppDeleteResource](../classes/webApp.WebAppDeleteResource.md) + +___ + +### WebAppDeleteResourceResponse + +Re-exports [WebAppDeleteResourceResponse](../classes/webApp.WebAppDeleteResourceResponse.md) + +___ + +### WebAppDeleteResponse + +Re-exports [WebAppDeleteResponse](../classes/webApp.WebAppDeleteResponse.md) + +___ + +### WebAppDownloadResource + +Re-exports [WebAppDownloadResource](../classes/webApp.WebAppDownloadResource.md) + +___ + +### WebAppDownloadResourceResponse + +Re-exports [WebAppDownloadResourceResponse](../classes/webApp.WebAppDownloadResourceResponse.md) + +___ + +### WebAppRename + +Re-exports [WebAppRename](../classes/webApp.WebAppRename.md) + +___ + +### WebAppRenameResource + +Re-exports [WebAppRenameResource](../classes/webApp.WebAppRenameResource.md) + +___ + +### WebAppRenameResourceResponse + +Re-exports [WebAppRenameResourceResponse](../classes/webApp.WebAppRenameResourceResponse.md) + +___ + +### WebAppRenameResponse + +Re-exports [WebAppRenameResponse](../classes/webApp.WebAppRenameResponse.md) + +___ + +### WebAppSetDefaultPage + +Re-exports [WebAppSetDefaultPage](../classes/webApp.WebAppSetDefaultPage.md) + +___ + +### WebAppSetDefaultPageResponse + +Re-exports [WebAppSetDefaultPageResponse](../classes/webApp.WebAppSetDefaultPageResponse.md) + +___ + +### WebAppSetNotAuthorizedPage + +Re-exports [WebAppSetNotAuthorizedPage](../classes/webApp.WebAppSetNotAuthorizedPage.md) + +___ + +### WebAppSetNotAuthorizedPageResponse + +Re-exports [WebAppSetNotAuthorizedPageResponse](../classes/webApp.WebAppSetNotAuthorizedPageResponse.md) + +___ + +### WebAppSetNotFoundPage + +Re-exports [WebAppSetNotFoundPage](../classes/webApp.WebAppSetNotFoundPage.md) + +___ + +### WebAppSetNotFoundPageResponse + +Re-exports [WebAppSetNotFoundPageResponse](../classes/webApp.WebAppSetNotFoundPageResponse.md) + +___ + +### WebAppSetResourceETag + +Re-exports [WebAppSetResourceETag](../classes/webApp.WebAppSetResourceETag.md) + +___ + +### WebAppSetResourceETagResponse + +Re-exports [WebAppSetResourceETagResponse](../classes/webApp.WebAppSetResourceETagResponse.md) + +___ + +### WebAppSetResourceMediaType + +Re-exports [WebAppSetResourceMediaType](../classes/webApp.WebAppSetResourceMediaType.md) + +___ + +### WebAppSetResourceMediaTypeResponse + +Re-exports [WebAppSetResourceMediaTypeResponse](../classes/webApp.WebAppSetResourceMediaTypeResponse.md) + +___ + +### WebAppSetResourceModificationTime + +Re-exports [WebAppSetResourceModificationTime](../classes/webApp.WebAppSetResourceModificationTime.md) + +___ + +### WebAppSetResourceModificationTimeResponse + +Re-exports [WebAppSetResourceModificationTimeResponse](../classes/webApp.WebAppSetResourceModificationTimeResponse.md) + +___ + +### WebAppSetResourceVisibility + +Re-exports [WebAppSetResourceVisibility](../classes/webApp.WebAppSetResourceVisibility.md) + +___ + +### WebAppSetResourceVisibilityResponse + +Re-exports [WebAppSetResourceVisibilityResponse](../classes/webApp.WebAppSetResourceVisibilityResponse.md) + +___ + +### WebAppSetState + +Re-exports [WebAppSetState](../classes/webApp.WebAppSetState.md) + +___ + +### WebAppSetStateResponse + +Re-exports [WebAppSetStateResponse](../classes/webApp.WebAppSetStateResponse.md) + +___ + +### WebServerReadDefaultPage + +Re-exports [WebServerReadDefaultPage](../classes/webserver.WebServerReadDefaultPage.md) + +___ + +### WebServerReadDefaultPageResponse + +Re-exports [WebServerReadDefaultPageResponse](../classes/webserver.WebServerReadDefaultPageResponse.md) + +___ + +### WebServerSetDefaultPage + +Re-exports [WebServerSetDefaultPage](../classes/webserver.WebServerSetDefaultPage.md) + +___ + +### WebServerSetDefaultPageResponse + +Re-exports [WebServerSetDefaultPageResponse](../classes/webserver.WebServerSetDefaultPageResponse.md) + +___ + +### obtainEnumValue + +Re-exports [obtainEnumValue](plc.md#obtainenumvalue) diff --git a/docs/modules/plc.md b/docs/modules/plc.md new file mode 100644 index 0000000..9f5be35 --- /dev/null +++ b/docs/modules/plc.md @@ -0,0 +1,64 @@ +[typescript-simatic-s7-webserver-api](../../README.md) / [Exports](../modules.md) / plc + +# Module: plc + +## Table of contents + +### Enumerations + +- [PlcOpertingMode](../enums/plc.PlcOpertingMode.md) + +### Classes + +- [PlcCreateBackup](../classes/plc.PlcCreateBackup.md) +- [PlcCreateBackupResponse](../classes/plc.PlcCreateBackupResponse.md) +- [PlcReadOperatingMode](../classes/plc.PlcReadOperatingMode.md) +- [PlcReadOperatingModeResponse](../classes/plc.PlcReadOperatingModeResponse.md) +- [PlcReadSystemTime](../classes/plc.PlcReadSystemTime.md) +- [PlcReadSystemTimeResponse](../classes/plc.PlcReadSystemTimeResponse.md) +- [PlcReadTimeSettings](../classes/plc.PlcReadTimeSettings.md) +- [PlcReadTimeSettingsResponse](../classes/plc.PlcReadTimeSettingsResponse.md) +- [PlcRequestChangeOperatingMode](../classes/plc.PlcRequestChangeOperatingMode.md) +- [PlcRequestChangeOperatingModeResponse](../classes/plc.PlcRequestChangeOperatingModeResponse.md) +- [PlcRestoreBackup](../classes/plc.PlcRestoreBackup.md) +- [PlcRestoreBackupResponse](../classes/plc.PlcRestoreBackupResponse.md) +- [PlcSetSystemTime](../classes/plc.PlcSetSystemTime.md) +- [PlcSetSystemTimeResponse](../classes/plc.PlcSetSystemTimeResponse.md) +- [PlcSetTimeSettings](../classes/plc.PlcSetTimeSettings.md) +- [PlcSetTimeSettingsResponse](../classes/plc.PlcSetTimeSettingsResponse.md) +- [Rule](../classes/plc.Rule.md) +- [RuleDst](../classes/plc.RuleDst.md) +- [RuleStart](../classes/plc.RuleStart.md) +- [RuleStd](../classes/plc.RuleStd.md) +- [TimeSettings](../classes/plc.TimeSettings.md) + +### Functions + +- [obtainEnumValue](plc.md#obtainenumvalue) + +## Functions + +### obtainEnumValue + +▸ **obtainEnumValue**\<`T`\>(`enumObj`, `value`): `T`[keyof `T`] \| `undefined` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `Record`\<`string`, `any`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `enumObj` | `T` | +| `value` | keyof `T` | + +#### Returns + +`T`[keyof `T`] \| `undefined` + +#### Defined in + +plc.ts:14 diff --git a/docs/modules/plcprogram.md b/docs/modules/plcprogram.md new file mode 100644 index 0000000..dcd86fa --- /dev/null +++ b/docs/modules/plcprogram.md @@ -0,0 +1,18 @@ +[typescript-simatic-s7-webserver-api](../../README.md) / [Exports](../modules.md) / plcprogram + +# Module: plcprogram + +## Table of contents + +### Classes + +- [PlcProgramBrowse](../classes/plcprogram.PlcProgramBrowse.md) +- [PlcProgramBrowseArrayData](../classes/plcprogram.PlcProgramBrowseArrayData.md) +- [PlcProgramBrowseResponse](../classes/plcprogram.PlcProgramBrowseResponse.md) +- [PlcProgramBrowseVariable](../classes/plcprogram.PlcProgramBrowseVariable.md) +- [PlcProgramDownloadProfilingData](../classes/plcprogram.PlcProgramDownloadProfilingData.md) +- [PlcProgramDownloadProfilingDataResponse](../classes/plcprogram.PlcProgramDownloadProfilingDataResponse.md) +- [PlcProgramRead](../classes/plcprogram.PlcProgramRead.md) +- [PlcProgramReadResponse](../classes/plcprogram.PlcProgramReadResponse.md) +- [PlcProgramWrite](../classes/plcprogram.PlcProgramWrite.md) +- [PlcProgramWriteResponse](../classes/plcprogram.PlcProgramWriteResponse.md) diff --git a/docs/modules/project.md b/docs/modules/project.md new file mode 100644 index 0000000..473e05c --- /dev/null +++ b/docs/modules/project.md @@ -0,0 +1,11 @@ +[typescript-simatic-s7-webserver-api](../../README.md) / [Exports](../modules.md) / project + +# Module: project + +## Table of contents + +### Classes + +- [Languages](../classes/project.Languages.md) +- [ProjectLanguages](../classes/project.ProjectLanguages.md) +- [ProjectLanguagesResponse](../classes/project.ProjectLanguagesResponse.md) diff --git a/docs/modules/request.md b/docs/modules/request.md new file mode 100644 index 0000000..272932b --- /dev/null +++ b/docs/modules/request.md @@ -0,0 +1,10 @@ +[typescript-simatic-s7-webserver-api](../../README.md) / [Exports](../modules.md) / request + +# Module: request + +## Table of contents + +### Classes + +- [JsonrpcBaseRequest](../classes/request.JsonrpcBaseRequest.md) +- [RequestConfig](../classes/request.RequestConfig.md) diff --git a/docs/modules/response.md b/docs/modules/response.md new file mode 100644 index 0000000..f5bec69 --- /dev/null +++ b/docs/modules/response.md @@ -0,0 +1,10 @@ +[typescript-simatic-s7-webserver-api](../README.md) / [Exports](../../README.md) / response + +# Module: response + +## Table of contents + +### Classes + +- [JsonrpcBaseResponse](../classes/response.JsonrpcBaseResponse.md) +- [JsonrpcError](../classes/response.JsonrpcError.md) diff --git a/docs/modules/syslog.md b/docs/modules/syslog.md new file mode 100644 index 0000000..34bf9ef --- /dev/null +++ b/docs/modules/syslog.md @@ -0,0 +1,12 @@ +[typescript-simatic-s7-webserver-api](../../README.md) / [Exports](../modules.md) / syslog + +# Module: syslog + +## Table of contents + +### Classes + +- [SyslogBrowse](../classes/syslog.SyslogBrowse.md) +- [SyslogBrowseResponse](../classes/syslog.SyslogBrowseResponse.md) +- [SyslogBrowseStructure](../classes/syslog.SyslogBrowseStructure.md) +- [SyslogData](../classes/syslog.SyslogData.md) diff --git a/docs/modules/ticket.md b/docs/modules/ticket.md new file mode 100644 index 0000000..e432fbe --- /dev/null +++ b/docs/modules/ticket.md @@ -0,0 +1,12 @@ +[typescript-simatic-s7-webserver-api](../../README.md) / [Exports](../modules.md) / ticket + +# Module: ticket + +## Table of contents + +### Classes + +- [ProxyTicketDownloadData](../classes/ticket.ProxyTicketDownloadData.md) +- [ProxyTicketUploadData](../classes/ticket.ProxyTicketUploadData.md) +- [TicketDownloadData](../classes/ticket.TicketDownloadData.md) +- [TicketUploadData](../classes/ticket.TicketUploadData.md) diff --git a/docs/modules/webApp.md b/docs/modules/webApp.md new file mode 100644 index 0000000..84406ea --- /dev/null +++ b/docs/modules/webApp.md @@ -0,0 +1,46 @@ +[typescript-simatic-s7-webserver-api](../../README.md) / [Exports](../modules.md) / webApp + +# Module: webApp + +## Table of contents + +### Classes + +- [Application](../classes/webApp.Application.md) +- [BrowseResourcesStructure](../classes/webApp.BrowseResourcesStructure.md) +- [BrowseStructure](../classes/webApp.BrowseStructure.md) +- [Resource](../classes/webApp.Resource.md) +- [WebAppBrowse](../classes/webApp.WebAppBrowse.md) +- [WebAppBrowseResources](../classes/webApp.WebAppBrowseResources.md) +- [WebAppBrowseResourcesResponse](../classes/webApp.WebAppBrowseResourcesResponse.md) +- [WebAppBrowseResponse](../classes/webApp.WebAppBrowseResponse.md) +- [WebAppCreate](../classes/webApp.WebAppCreate.md) +- [WebAppCreateResource](../classes/webApp.WebAppCreateResource.md) +- [WebAppCreateResourceResponse](../classes/webApp.WebAppCreateResourceResponse.md) +- [WebAppCreateResponse](../classes/webApp.WebAppCreateResponse.md) +- [WebAppDelete](../classes/webApp.WebAppDelete.md) +- [WebAppDeleteResource](../classes/webApp.WebAppDeleteResource.md) +- [WebAppDeleteResourceResponse](../classes/webApp.WebAppDeleteResourceResponse.md) +- [WebAppDeleteResponse](../classes/webApp.WebAppDeleteResponse.md) +- [WebAppDownloadResource](../classes/webApp.WebAppDownloadResource.md) +- [WebAppDownloadResourceResponse](../classes/webApp.WebAppDownloadResourceResponse.md) +- [WebAppRename](../classes/webApp.WebAppRename.md) +- [WebAppRenameResource](../classes/webApp.WebAppRenameResource.md) +- [WebAppRenameResourceResponse](../classes/webApp.WebAppRenameResourceResponse.md) +- [WebAppRenameResponse](../classes/webApp.WebAppRenameResponse.md) +- [WebAppSetDefaultPage](../classes/webApp.WebAppSetDefaultPage.md) +- [WebAppSetDefaultPageResponse](../classes/webApp.WebAppSetDefaultPageResponse.md) +- [WebAppSetNotAuthorizedPage](../classes/webApp.WebAppSetNotAuthorizedPage.md) +- [WebAppSetNotAuthorizedPageResponse](../classes/webApp.WebAppSetNotAuthorizedPageResponse.md) +- [WebAppSetNotFoundPage](../classes/webApp.WebAppSetNotFoundPage.md) +- [WebAppSetNotFoundPageResponse](../classes/webApp.WebAppSetNotFoundPageResponse.md) +- [WebAppSetResourceETag](../classes/webApp.WebAppSetResourceETag.md) +- [WebAppSetResourceETagResponse](../classes/webApp.WebAppSetResourceETagResponse.md) +- [WebAppSetResourceMediaType](../classes/webApp.WebAppSetResourceMediaType.md) +- [WebAppSetResourceMediaTypeResponse](../classes/webApp.WebAppSetResourceMediaTypeResponse.md) +- [WebAppSetResourceModificationTime](../classes/webApp.WebAppSetResourceModificationTime.md) +- [WebAppSetResourceModificationTimeResponse](../classes/webApp.WebAppSetResourceModificationTimeResponse.md) +- [WebAppSetResourceVisibility](../classes/webApp.WebAppSetResourceVisibility.md) +- [WebAppSetResourceVisibilityResponse](../classes/webApp.WebAppSetResourceVisibilityResponse.md) +- [WebAppSetState](../classes/webApp.WebAppSetState.md) +- [WebAppSetStateResponse](../classes/webApp.WebAppSetStateResponse.md) diff --git a/docs/modules/webserver.md b/docs/modules/webserver.md new file mode 100644 index 0000000..11a173c --- /dev/null +++ b/docs/modules/webserver.md @@ -0,0 +1,12 @@ +[typescript-simatic-s7-webserver-api](../../README.md) / [Exports](../modules.md) / webserver + +# Module: webserver + +## Table of contents + +### Classes + +- [WebServerReadDefaultPage](../classes/webserver.WebServerReadDefaultPage.md) +- [WebServerReadDefaultPageResponse](../classes/webserver.WebServerReadDefaultPageResponse.md) +- [WebServerSetDefaultPage](../classes/webserver.WebServerSetDefaultPage.md) +- [WebServerSetDefaultPageResponse](../classes/webserver.WebServerSetDefaultPageResponse.md) diff --git a/jest.config.js b/jest.config.js new file mode 100644 index 0000000..21fa37a --- /dev/null +++ b/jest.config.js @@ -0,0 +1,5 @@ +module.exports = { + preset: 'ts-jest', + testEnvironment: 'node', + testMatch: ['**/?(*.)+(spec|test).[jt]s?(x)'] +}; diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..ec43be5 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,7601 @@ +{ + "name": "@siemens/simatic-s7-webserver-api", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "@siemens/simatic-s7-webserver-api", + "version": "1.0.0", + "dependencies": { + "@eslint/config-array": "^0.19.0", + "axios": "^1.7.7", + "fs": "^0.0.1-security", + "glob": "^10.0.0", + "https": "^1.0.0", + "moment": "^2.30.1", + "pino": "^8.21.0" + }, + "devDependencies": { + "@types/jest": "^29.5.12", + "@types/moment": "^2.11.29", + "@types/node": "^20.16.5", + "@types/pino": "^7.0.4", + "@typescript-eslint/eslint-plugin": "^8.0.0", + "@typescript-eslint/parser": "^8.0.0", + "eslint": "^8.0.0", + "eslint-config-semistandard": "^17.0.0", + "eslint-config-standard": "^17.1.0", + "eslint-plugin-import": "^2.29.1", + "eslint-plugin-n": "^15.7.0", + "eslint-plugin-promise": "^6.1.1", + "jest": "^29.7.0", + "rimraf": "^4.0.0", + "ts-jest": "^29.2.4", + "typedoc": "^0.25.12", + "typedoc-plugin-markdown": "^3.17.1", + "typescript": "^5.3.3" + } + }, + "node_modules/@ampproject/remapping": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.3.0.tgz", + "integrity": "sha512-30iZtAPgz+LTIYoeivqYo853f02jBYSd5uGnGpkFV0M3xOt9aN73erkgYAmZU43x4VfqcnLxW9Kpg3R5LC4YYw==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@jridgewell/gen-mapping": "^0.3.5", + "@jridgewell/trace-mapping": "^0.3.24" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@babel/code-frame": { + "version": "7.26.2", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.26.2.tgz", + "integrity": "sha512-RJlIHRueQgwWitWgF8OdFYGZX328Ax5BCemNGlqHfplnRT9ESi8JkFlvaVYbS+UubVY6dpv87Fs2u5M29iNFVQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-validator-identifier": "^7.25.9", + "js-tokens": "^4.0.0", + "picocolors": "^1.0.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/compat-data": { + "version": "7.26.2", + "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.26.2.tgz", + "integrity": "sha512-Z0WgzSEa+aUcdiJuCIqgujCshpMWgUpgOxXotrYPSA53hA3qopNaqcJpyr0hVb1FeWdnqFA35/fUtXgBK8srQg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/core": { + "version": "7.26.0", + "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.26.0.tgz", + "integrity": "sha512-i1SLeK+DzNnQ3LL/CswPCa/E5u4lh1k6IAEphON8F+cXt0t9euTshDru0q7/IqMa1PMPz5RnHuHscF8/ZJsStg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@ampproject/remapping": "^2.2.0", + "@babel/code-frame": "^7.26.0", + "@babel/generator": "^7.26.0", + "@babel/helper-compilation-targets": "^7.25.9", + "@babel/helper-module-transforms": "^7.26.0", + "@babel/helpers": "^7.26.0", + "@babel/parser": "^7.26.0", + "@babel/template": "^7.25.9", + "@babel/traverse": "^7.25.9", + "@babel/types": "^7.26.0", + "convert-source-map": "^2.0.0", + "debug": "^4.1.0", + "gensync": "^1.0.0-beta.2", + "json5": "^2.2.3", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/babel" + } + }, + "node_modules/@babel/core/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/generator": { + "version": "7.26.2", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.26.2.tgz", + "integrity": "sha512-zevQbhbau95nkoxSq3f/DC/SC+EEOUZd3DYqfSkMhY2/wfSeaHV1Ew4vk8e+x8lja31IbyuUa2uQ3JONqKbysw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.26.2", + "@babel/types": "^7.26.0", + "@jridgewell/gen-mapping": "^0.3.5", + "@jridgewell/trace-mapping": "^0.3.25", + "jsesc": "^3.0.2" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-compilation-targets": { + "version": "7.25.9", + "resolved": "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.25.9.tgz", + "integrity": "sha512-j9Db8Suy6yV/VHa4qzrj9yZfZxhLWQdVnRlXxmKLYlhWUVB1sB2G5sxuWYXk/whHD9iW76PmNzxZ4UCnTQTVEQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/compat-data": "^7.25.9", + "@babel/helper-validator-option": "^7.25.9", + "browserslist": "^4.24.0", + "lru-cache": "^5.1.1", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-compilation-targets/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/helper-module-imports": { + "version": "7.25.9", + "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.25.9.tgz", + "integrity": "sha512-tnUA4RsrmflIM6W6RFTLFSXITtl0wKjgpnLgXyowocVPrbYrLUXSBXDgTs8BlbmIzIdlBySRQjINYs2BAkiLtw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/traverse": "^7.25.9", + "@babel/types": "^7.25.9" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-module-transforms": { + "version": "7.26.0", + "resolved": "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.26.0.tgz", + "integrity": "sha512-xO+xu6B5K2czEnQye6BHA7DolFFmS3LB7stHZFaOLb1pAwO1HWLS8fXA+eh0A2yIvltPVmx3eNNDBJA2SLHXFw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-module-imports": "^7.25.9", + "@babel/helper-validator-identifier": "^7.25.9", + "@babel/traverse": "^7.25.9" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-plugin-utils": { + "version": "7.25.9", + "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.25.9.tgz", + "integrity": "sha512-kSMlyUVdWe25rEsRGviIgOWnoT/nfABVWlqt9N19/dIPWViAOW2s9wznP5tURbs/IDuNk4gPy3YdYRgH3uxhBw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-string-parser": { + "version": "7.25.9", + "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.25.9.tgz", + "integrity": "sha512-4A/SCr/2KLd5jrtOMFzaKjVtAei3+2r/NChoBNoZ3EyP/+GlhoaEGoWOZUmFmoITP7zOJyHIMm+DYRd8o3PvHA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.25.9", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.25.9.tgz", + "integrity": "sha512-Ed61U6XJc3CVRfkERJWDz4dJwKe7iLmmJsbOGu9wSloNSFttHV0I8g6UAgb7qnK5ly5bGLPd4oXZlxCdANBOWQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-option": { + "version": "7.25.9", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-option/-/helper-validator-option-7.25.9.tgz", + "integrity": "sha512-e/zv1co8pp55dNdEcCynfj9X7nyUKUXoUEwfXqaZt0omVOmDe9oOTdKStH4GmAw6zxMFs50ZayuMfHDKlO7Tfw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helpers": { + "version": "7.26.0", + "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.26.0.tgz", + "integrity": "sha512-tbhNuIxNcVb21pInl3ZSjksLCvgdZy9KwJ8brv993QtIVKJBBkYXz4q4ZbAv31GdnC+R90np23L5FbEBlthAEw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/template": "^7.25.9", + "@babel/types": "^7.26.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/parser": { + "version": "7.26.2", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.26.2.tgz", + "integrity": "sha512-DWMCZH9WA4Maitz2q21SRKHo9QXZxkDsbNZoVD62gusNtNBBqDg9i7uOhASfTfIGNzW+O+r7+jAlM8dwphcJKQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/types": "^7.26.0" + }, + "bin": { + "parser": "bin/babel-parser.js" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@babel/plugin-syntax-async-generators": { + "version": "7.8.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-async-generators/-/plugin-syntax-async-generators-7.8.4.tgz", + "integrity": "sha512-tycmZxkGfZaxhMRbXlPXuVFpdWlXpir2W4AMhSJgRKzk/eDlIXOhb2LHWoLpDF7TEHylV5zNhykX6KAgHJmTNw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-bigint": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-bigint/-/plugin-syntax-bigint-7.8.3.tgz", + "integrity": "sha512-wnTnFlG+YxQm3vDxpGE57Pj0srRU4sHE/mDkt1qv2YJJSeUAec2ma4WLUnUPeKjyrfntVwe/N6dCXpU+zL3Npg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-class-properties": { + "version": "7.12.13", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-class-properties/-/plugin-syntax-class-properties-7.12.13.tgz", + "integrity": "sha512-fm4idjKla0YahUNgFNLCB0qySdsoPiZP3iQE3rky0mBUtMZ23yDJ9SJdg6dXTSDnulOVqiF3Hgr9nbXvXTQZYA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.12.13" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-class-static-block": { + "version": "7.14.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-class-static-block/-/plugin-syntax-class-static-block-7.14.5.tgz", + "integrity": "sha512-b+YyPmr6ldyNnM6sqYeMWE+bgJcJpO6yS4QD7ymxgH34GBPNDM/THBh8iunyvKIZztiwLH4CJZ0RxTk9emgpjw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.14.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-import-attributes": { + "version": "7.26.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.26.0.tgz", + "integrity": "sha512-e2dttdsJ1ZTpi3B9UYGLw41hifAubg19AtCu/2I/F1QNVclOBr1dYpTdmdyZ84Xiz43BS/tCUkMAZNLv12Pi+A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.25.9" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-import-meta": { + "version": "7.10.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-meta/-/plugin-syntax-import-meta-7.10.4.tgz", + "integrity": "sha512-Yqfm+XDx0+Prh3VSeEQCPU81yC+JWZ2pDPFSS4ZdpfZhp4MkFMaDC1UqseovEKwSUpnIL7+vK+Clp7bfh0iD7g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.10.4" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-json-strings": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-json-strings/-/plugin-syntax-json-strings-7.8.3.tgz", + "integrity": "sha512-lY6kdGpWHvjoe2vk4WrAapEuBR69EMxZl+RoGRhrFGNYVK8mOPAW8VfbT/ZgrFbXlDNiiaxQnAtgVCZ6jv30EA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-jsx": { + "version": "7.25.9", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.25.9.tgz", + "integrity": "sha512-ld6oezHQMZsZfp6pWtbjaNDF2tiiCYYDqQszHt5VV437lewP9aSi2Of99CK0D0XB21k7FLgnLcmQKyKzynfeAA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.25.9" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-logical-assignment-operators": { + "version": "7.10.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-logical-assignment-operators/-/plugin-syntax-logical-assignment-operators-7.10.4.tgz", + "integrity": "sha512-d8waShlpFDinQ5MtvGU9xDAOzKH47+FFoney2baFIoMr952hKOLp1HR7VszoZvOsV/4+RRszNY7D17ba0te0ig==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.10.4" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-nullish-coalescing-operator": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-nullish-coalescing-operator/-/plugin-syntax-nullish-coalescing-operator-7.8.3.tgz", + "integrity": "sha512-aSff4zPII1u2QD7y+F8oDsz19ew4IGEJg9SVW+bqwpwtfFleiQDMdzA/R+UlWDzfnHFCxxleFT0PMIrR36XLNQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-numeric-separator": { + "version": "7.10.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-numeric-separator/-/plugin-syntax-numeric-separator-7.10.4.tgz", + "integrity": "sha512-9H6YdfkcK/uOnY/K7/aA2xpzaAgkQn37yzWUMRK7OaPOqOpGS1+n0H5hxT9AUw9EsSjPW8SVyMJwYRtWs3X3ug==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.10.4" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-object-rest-spread": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-object-rest-spread/-/plugin-syntax-object-rest-spread-7.8.3.tgz", + "integrity": "sha512-XoqMijGZb9y3y2XskN+P1wUGiVwWZ5JmoDRwx5+3GmEplNyVM2s2Dg8ILFQm8rWM48orGy5YpI5Bl8U1y7ydlA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-optional-catch-binding": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-optional-catch-binding/-/plugin-syntax-optional-catch-binding-7.8.3.tgz", + "integrity": "sha512-6VPD0Pc1lpTqw0aKoeRTMiB+kWhAoT24PA+ksWSBrFtl5SIRVpZlwN3NNPQjehA2E/91FV3RjLWoVTglWcSV3Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-optional-chaining": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-optional-chaining/-/plugin-syntax-optional-chaining-7.8.3.tgz", + "integrity": "sha512-KoK9ErH1MBlCPxV0VANkXW2/dw4vlbGDrFgz8bmUsBGYkFRcbRwMh6cIJubdPrkxRwuGdtCk0v/wPTKbQgBjkg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-private-property-in-object": { + "version": "7.14.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-private-property-in-object/-/plugin-syntax-private-property-in-object-7.14.5.tgz", + "integrity": "sha512-0wVnp9dxJ72ZUJDV27ZfbSj6iHLoytYZmh3rFcxNnvsJF3ktkzLDZPy/mA17HGsaQT3/DQsWYX1f1QGWkCoVUg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.14.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-top-level-await": { + "version": "7.14.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-top-level-await/-/plugin-syntax-top-level-await-7.14.5.tgz", + "integrity": "sha512-hx++upLv5U1rgYfwe1xBQUhRmU41NEvpUvrp8jkrSCdvGSnM5/qdRMtylJ6PG5OFkBaHkbTAKTnd3/YyESRHFw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.14.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-typescript": { + "version": "7.25.9", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.25.9.tgz", + "integrity": "sha512-hjMgRy5hb8uJJjUcdWunWVcoi9bGpJp8p5Ol1229PoN6aytsLwNMgmdftO23wnCLMfVmTwZDWMPNq/D1SY60JQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.25.9" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/template": { + "version": "7.25.9", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.25.9.tgz", + "integrity": "sha512-9DGttpmPvIxBb/2uwpVo3dqJ+O6RooAFOS+lB+xDqoE2PVCE8nfoHMdZLpfCQRLwvohzXISPZcgxt80xLfsuwg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.25.9", + "@babel/parser": "^7.25.9", + "@babel/types": "^7.25.9" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/traverse": { + "version": "7.25.9", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.25.9.tgz", + "integrity": "sha512-ZCuvfwOwlz/bawvAuvcj8rrithP2/N55Tzz342AkTvq4qaWbGfmCk/tKhNaV2cthijKrPAA8SRJV5WWe7IBMJw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.25.9", + "@babel/generator": "^7.25.9", + "@babel/parser": "^7.25.9", + "@babel/template": "^7.25.9", + "@babel/types": "^7.25.9", + "debug": "^4.3.1", + "globals": "^11.1.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/traverse/node_modules/globals": { + "version": "11.12.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-11.12.0.tgz", + "integrity": "sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/@babel/types": { + "version": "7.26.0", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.26.0.tgz", + "integrity": "sha512-Z/yiTPj+lDVnF7lWeKCIJzaIkI0vYO87dMpZ4bg4TDrFe4XXLFWL1TbXU27gBP3QccxV9mZICCrnjnYlJjXHOA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-string-parser": "^7.25.9", + "@babel/helper-validator-identifier": "^7.25.9" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@bcoe/v8-coverage": { + "version": "0.2.3", + "resolved": "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz", + "integrity": "sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@eslint-community/eslint-utils": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.4.1.tgz", + "integrity": "sha512-s3O3waFUrMV8P/XaF/+ZTp1X9XBZW1a4B97ZnjQF2KYWaFD2A8KyFBsrsfSjEmjn3RGWAIuvlneuZm3CUK3jbA==", + "dev": true, + "license": "MIT", + "dependencies": { + "eslint-visitor-keys": "^3.4.3" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + }, + "peerDependencies": { + "eslint": "^6.0.0 || ^7.0.0 || >=8.0.0" + } + }, + "node_modules/@eslint-community/regexpp": { + "version": "4.12.1", + "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.12.1.tgz", + "integrity": "sha512-CCZCDJuduB9OUkFkY2IgppNZMi2lBQgD2qzwXkEia16cge2pijY/aXi96CJMquDMn3nJdlPV1A5KrJEXwfLNzQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^12.0.0 || ^14.0.0 || >=16.0.0" + } + }, + "node_modules/@eslint/config-array": { + "version": "0.19.0", + "resolved": "https://registry.npmjs.org/@eslint/config-array/-/config-array-0.19.0.tgz", + "integrity": "sha512-zdHg2FPIFNKPdcHWtiNT+jEFCHYVplAXRDlQDyqy0zGx/q2parwh7brGJSiTxRk/TSMkbM//zt/f5CHgyTyaSQ==", + "license": "Apache-2.0", + "dependencies": { + "@eslint/object-schema": "^2.1.4", + "debug": "^4.3.1", + "minimatch": "^3.1.2" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + } + }, + "node_modules/@eslint/eslintrc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-2.1.4.tgz", + "integrity": "sha512-269Z39MS6wVJtsoUl10L60WdkhJVdPG24Q4eZTH3nnF6lpvSShEK3wQjDX9JRWAUPvPh7COouPpU9IrqaZFvtQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ajv": "^6.12.4", + "debug": "^4.3.2", + "espree": "^9.6.0", + "globals": "^13.19.0", + "ignore": "^5.2.0", + "import-fresh": "^3.2.1", + "js-yaml": "^4.1.0", + "minimatch": "^3.1.2", + "strip-json-comments": "^3.1.1" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, + "node_modules/@eslint/js": { + "version": "8.57.1", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.57.1.tgz", + "integrity": "sha512-d9zaMRSTIKDLhctzH12MtXvJKSSUhaHcjV+2Z+GK+EEY7XKpP5yR4x+N3TAcHTcu963nIr+TMcCb4DBCYX1z6Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + } + }, + "node_modules/@eslint/object-schema": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@eslint/object-schema/-/object-schema-2.1.4.tgz", + "integrity": "sha512-BsWiH1yFGjXXS2yvrf5LyuoSIIbPrGUWob917o+BTKuZ7qJdxX8aJLRxs1fS9n6r7vESrq1OUqb68dANcFXuQQ==", + "license": "Apache-2.0", + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + } + }, + "node_modules/@humanwhocodes/config-array": { + "version": "0.13.0", + "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.13.0.tgz", + "integrity": "sha512-DZLEEqFWQFiyK6h5YIeynKx7JlvCYWL0cImfSRXZ9l4Sg2efkFGTuFf6vzXjK1cq6IYkU+Eg/JizXw+TD2vRNw==", + "deprecated": "Use @eslint/config-array instead", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@humanwhocodes/object-schema": "^2.0.3", + "debug": "^4.3.1", + "minimatch": "^3.0.5" + }, + "engines": { + "node": ">=10.10.0" + } + }, + "node_modules/@humanwhocodes/module-importer": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@humanwhocodes/module-importer/-/module-importer-1.0.1.tgz", + "integrity": "sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=12.22" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/nzakas" + } + }, + "node_modules/@humanwhocodes/object-schema": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/@humanwhocodes/object-schema/-/object-schema-2.0.3.tgz", + "integrity": "sha512-93zYdMES/c1D69yZiKDBj0V24vqNzB/koF26KPaagAfd3P/4gUlh3Dys5ogAK+Exi9QyzlD8x/08Zt7wIKcDcA==", + "deprecated": "Use @eslint/object-schema instead", + "dev": true, + "license": "BSD-3-Clause" + }, + "node_modules/@isaacs/cliui": { + "version": "8.0.2", + "resolved": "https://registry.npmjs.org/@isaacs/cliui/-/cliui-8.0.2.tgz", + "integrity": "sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA==", + "license": "ISC", + "dependencies": { + "string-width": "^5.1.2", + "string-width-cjs": "npm:string-width@^4.2.0", + "strip-ansi": "^7.0.1", + "strip-ansi-cjs": "npm:strip-ansi@^6.0.1", + "wrap-ansi": "^8.1.0", + "wrap-ansi-cjs": "npm:wrap-ansi@^7.0.0" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@isaacs/cliui/node_modules/ansi-regex": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.1.0.tgz", + "integrity": "sha512-7HSX4QQb4CspciLpVFwyRe79O3xsIZDDLER21kERQ71oaPodF8jL725AgJMFAYbooIqolJoRLuM81SpeUkpkvA==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" + } + }, + "node_modules/@isaacs/cliui/node_modules/ansi-styles": { + "version": "6.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz", + "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/@isaacs/cliui/node_modules/emoji-regex": { + "version": "9.2.2", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", + "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==", + "license": "MIT" + }, + "node_modules/@isaacs/cliui/node_modules/string-width": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", + "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", + "license": "MIT", + "dependencies": { + "eastasianwidth": "^0.2.0", + "emoji-regex": "^9.2.2", + "strip-ansi": "^7.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/@isaacs/cliui/node_modules/strip-ansi": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", + "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^6.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/strip-ansi?sponsor=1" + } + }, + "node_modules/@isaacs/cliui/node_modules/wrap-ansi": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz", + "integrity": "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==", + "license": "MIT", + "dependencies": { + "ansi-styles": "^6.1.0", + "string-width": "^5.0.1", + "strip-ansi": "^7.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/@istanbuljs/load-nyc-config": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@istanbuljs/load-nyc-config/-/load-nyc-config-1.1.0.tgz", + "integrity": "sha512-VjeHSlIzpv/NyD3N0YuHfXOPDIixcA1q2ZV98wsMqcYlPmv2n3Yb2lYP9XMElnaFVXg5A7YLTeLu6V84uQDjmQ==", + "dev": true, + "license": "ISC", + "dependencies": { + "camelcase": "^5.3.1", + "find-up": "^4.1.0", + "get-package-type": "^0.1.0", + "js-yaml": "^3.13.1", + "resolve-from": "^5.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/@istanbuljs/load-nyc-config/node_modules/argparse": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", + "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "dev": true, + "license": "MIT", + "dependencies": { + "sprintf-js": "~1.0.2" + } + }, + "node_modules/@istanbuljs/load-nyc-config/node_modules/find-up": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", + "integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==", + "dev": true, + "license": "MIT", + "dependencies": { + "locate-path": "^5.0.0", + "path-exists": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/@istanbuljs/load-nyc-config/node_modules/js-yaml": { + "version": "3.14.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz", + "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==", + "dev": true, + "license": "MIT", + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/@istanbuljs/load-nyc-config/node_modules/locate-path": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", + "integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==", + "dev": true, + "license": "MIT", + "dependencies": { + "p-locate": "^4.1.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/@istanbuljs/load-nyc-config/node_modules/p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "license": "MIT", + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/@istanbuljs/load-nyc-config/node_modules/p-locate": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", + "integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==", + "dev": true, + "license": "MIT", + "dependencies": { + "p-limit": "^2.2.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/@istanbuljs/load-nyc-config/node_modules/resolve-from": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-5.0.0.tgz", + "integrity": "sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/@istanbuljs/schema": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/@istanbuljs/schema/-/schema-0.1.3.tgz", + "integrity": "sha512-ZXRY4jNvVgSVQ8DL3LTcakaAtXwTVUxE81hslsyD2AtoXW/wVob10HkOJ1X/pAlcI7D+2YoZKg5do8G/w6RYgA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/@jest/console": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/@jest/console/-/console-29.7.0.tgz", + "integrity": "sha512-5Ni4CU7XHQi32IJ398EEP4RrB8eV09sXP2ROqD4bksHrnTree52PsxvX8tpL8LvTZ3pFzXyPbNQReSN41CAhOg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^29.6.3", + "@types/node": "*", + "chalk": "^4.0.0", + "jest-message-util": "^29.7.0", + "jest-util": "^29.7.0", + "slash": "^3.0.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/@jest/core": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/@jest/core/-/core-29.7.0.tgz", + "integrity": "sha512-n7aeXWKMnGtDA48y8TLWJPJmLmmZ642Ceo78cYWEpiD7FzDgmNDV/GCVRorPABdXLJZ/9wzzgZAlHjXjxDHGsg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/console": "^29.7.0", + "@jest/reporters": "^29.7.0", + "@jest/test-result": "^29.7.0", + "@jest/transform": "^29.7.0", + "@jest/types": "^29.6.3", + "@types/node": "*", + "ansi-escapes": "^4.2.1", + "chalk": "^4.0.0", + "ci-info": "^3.2.0", + "exit": "^0.1.2", + "graceful-fs": "^4.2.9", + "jest-changed-files": "^29.7.0", + "jest-config": "^29.7.0", + "jest-haste-map": "^29.7.0", + "jest-message-util": "^29.7.0", + "jest-regex-util": "^29.6.3", + "jest-resolve": "^29.7.0", + "jest-resolve-dependencies": "^29.7.0", + "jest-runner": "^29.7.0", + "jest-runtime": "^29.7.0", + "jest-snapshot": "^29.7.0", + "jest-util": "^29.7.0", + "jest-validate": "^29.7.0", + "jest-watcher": "^29.7.0", + "micromatch": "^4.0.4", + "pretty-format": "^29.7.0", + "slash": "^3.0.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + }, + "peerDependencies": { + "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" + }, + "peerDependenciesMeta": { + "node-notifier": { + "optional": true + } + } + }, + "node_modules/@jest/environment": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-29.7.0.tgz", + "integrity": "sha512-aQIfHDq33ExsN4jP1NWGXhxgQ/wixs60gDiKO+XVMd8Mn0NWPWgc34ZQDTb2jKaUWQ7MuwoitXAsN2XVXNMpAw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/fake-timers": "^29.7.0", + "@jest/types": "^29.6.3", + "@types/node": "*", + "jest-mock": "^29.7.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/@jest/expect": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/@jest/expect/-/expect-29.7.0.tgz", + "integrity": "sha512-8uMeAMycttpva3P1lBHB8VciS9V0XAr3GymPpipdyQXbBcuhkLQOSe8E/p92RyAdToS6ZD1tFkX+CkhoECE0dQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "expect": "^29.7.0", + "jest-snapshot": "^29.7.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/@jest/expect-utils": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/@jest/expect-utils/-/expect-utils-29.7.0.tgz", + "integrity": "sha512-GlsNBWiFQFCVi9QVSx7f5AgMeLxe9YCCs5PuP2O2LdjDAA8Jh9eX7lA1Jq/xdXw3Wb3hyvlFNfZIfcRetSzYcA==", + "dev": true, + "license": "MIT", + "dependencies": { + "jest-get-type": "^29.6.3" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/@jest/fake-timers": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-29.7.0.tgz", + "integrity": "sha512-q4DH1Ha4TTFPdxLsqDXK1d3+ioSL7yL5oCMJZgDYm6i+6CygW5E5xVr/D1HdsGxjt1ZWSfUAs9OxSB/BNelWrQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^29.6.3", + "@sinonjs/fake-timers": "^10.0.2", + "@types/node": "*", + "jest-message-util": "^29.7.0", + "jest-mock": "^29.7.0", + "jest-util": "^29.7.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/@jest/globals": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/@jest/globals/-/globals-29.7.0.tgz", + "integrity": "sha512-mpiz3dutLbkW2MNFubUGUEVLkTGiqW6yLVTA+JbP6fI6J5iL9Y0Nlg8k95pcF8ctKwCS7WVxteBs29hhfAotzQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/environment": "^29.7.0", + "@jest/expect": "^29.7.0", + "@jest/types": "^29.6.3", + "jest-mock": "^29.7.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/@jest/reporters": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/@jest/reporters/-/reporters-29.7.0.tgz", + "integrity": "sha512-DApq0KJbJOEzAFYjHADNNxAE3KbhxQB1y5Kplb5Waqw6zVbuWatSnMjE5gs8FUgEPmNsnZA3NCWl9NG0ia04Pg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@bcoe/v8-coverage": "^0.2.3", + "@jest/console": "^29.7.0", + "@jest/test-result": "^29.7.0", + "@jest/transform": "^29.7.0", + "@jest/types": "^29.6.3", + "@jridgewell/trace-mapping": "^0.3.18", + "@types/node": "*", + "chalk": "^4.0.0", + "collect-v8-coverage": "^1.0.0", + "exit": "^0.1.2", + "glob": "^7.1.3", + "graceful-fs": "^4.2.9", + "istanbul-lib-coverage": "^3.0.0", + "istanbul-lib-instrument": "^6.0.0", + "istanbul-lib-report": "^3.0.0", + "istanbul-lib-source-maps": "^4.0.0", + "istanbul-reports": "^3.1.3", + "jest-message-util": "^29.7.0", + "jest-util": "^29.7.0", + "jest-worker": "^29.7.0", + "slash": "^3.0.0", + "string-length": "^4.0.1", + "strip-ansi": "^6.0.0", + "v8-to-istanbul": "^9.0.1" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + }, + "peerDependencies": { + "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" + }, + "peerDependenciesMeta": { + "node-notifier": { + "optional": true + } + } + }, + "node_modules/@jest/reporters/node_modules/glob": { + "version": "7.2.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", + "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", + "deprecated": "Glob versions prior to v9 are no longer supported", + "dev": true, + "license": "ISC", + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.1.1", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/@jest/schemas": { + "version": "29.6.3", + "resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-29.6.3.tgz", + "integrity": "sha512-mo5j5X+jIZmJQveBKeS/clAueipV7KgiX1vMgCxam1RNYiqE1w62n0/tJJnHtjW8ZHcQco5gY85jA3mi0L+nSA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@sinclair/typebox": "^0.27.8" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/@jest/source-map": { + "version": "29.6.3", + "resolved": "https://registry.npmjs.org/@jest/source-map/-/source-map-29.6.3.tgz", + "integrity": "sha512-MHjT95QuipcPrpLM+8JMSzFx6eHp5Bm+4XeFDJlwsvVBjmKNiIAvasGK2fxz2WbGRlnvqehFbh07MMa7n3YJnw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/trace-mapping": "^0.3.18", + "callsites": "^3.0.0", + "graceful-fs": "^4.2.9" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/@jest/test-result": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/@jest/test-result/-/test-result-29.7.0.tgz", + "integrity": "sha512-Fdx+tv6x1zlkJPcWXmMDAG2HBnaR9XPSd5aDWQVsfrZmLVT3lU1cwyxLgRmXR9yrq4NBoEm9BMsfgFzTQAbJYA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/console": "^29.7.0", + "@jest/types": "^29.6.3", + "@types/istanbul-lib-coverage": "^2.0.0", + "collect-v8-coverage": "^1.0.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/@jest/test-sequencer": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/@jest/test-sequencer/-/test-sequencer-29.7.0.tgz", + "integrity": "sha512-GQwJ5WZVrKnOJuiYiAF52UNUJXgTZx1NHjFSEB0qEMmSZKAkdMoIzw/Cj6x6NF4AvV23AUqDpFzQkN/eYCYTxw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/test-result": "^29.7.0", + "graceful-fs": "^4.2.9", + "jest-haste-map": "^29.7.0", + "slash": "^3.0.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/@jest/transform": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/@jest/transform/-/transform-29.7.0.tgz", + "integrity": "sha512-ok/BTPFzFKVMwO5eOHRrvnBVHdRy9IrsrW1GpMaQ9MCnilNLXQKmAX8s1YXDFaai9xJpac2ySzV0YeRRECr2Vw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/core": "^7.11.6", + "@jest/types": "^29.6.3", + "@jridgewell/trace-mapping": "^0.3.18", + "babel-plugin-istanbul": "^6.1.1", + "chalk": "^4.0.0", + "convert-source-map": "^2.0.0", + "fast-json-stable-stringify": "^2.1.0", + "graceful-fs": "^4.2.9", + "jest-haste-map": "^29.7.0", + "jest-regex-util": "^29.6.3", + "jest-util": "^29.7.0", + "micromatch": "^4.0.4", + "pirates": "^4.0.4", + "slash": "^3.0.0", + "write-file-atomic": "^4.0.2" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/@jest/types": { + "version": "29.6.3", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.6.3.tgz", + "integrity": "sha512-u3UPsIilWKOM3F9CXtrG8LEJmNxwoCQC/XVj4IKYXvvpx7QIi/Kg1LI5uDmDpKlac62NUtX7eLjRh+jVZcLOzw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/schemas": "^29.6.3", + "@types/istanbul-lib-coverage": "^2.0.0", + "@types/istanbul-reports": "^3.0.0", + "@types/node": "*", + "@types/yargs": "^17.0.8", + "chalk": "^4.0.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/@jridgewell/gen-mapping": { + "version": "0.3.5", + "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.5.tgz", + "integrity": "sha512-IzL8ZoEDIBRWEzlCcRhOaCupYyN5gdIK+Q6fbFdPDg6HqX6jpkItn7DFIpW9LQzXG6Df9sA7+OKnq0qlz/GaQg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/set-array": "^1.2.1", + "@jridgewell/sourcemap-codec": "^1.4.10", + "@jridgewell/trace-mapping": "^0.3.24" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/resolve-uri": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", + "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/set-array": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@jridgewell/set-array/-/set-array-1.2.1.tgz", + "integrity": "sha512-R8gLRTZeyp03ymzP/6Lil/28tGeGEzhx1q2k703KGWRAI1VdvPIXdG70VJc2pAMw3NA6JKL5hhFu1sJX0Mnn/A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.0.tgz", + "integrity": "sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@jridgewell/trace-mapping": { + "version": "0.3.25", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.25.tgz", + "integrity": "sha512-vNk6aEwybGtawWmy/PzwnGDOjCkLWSD2wqvjGGAgOAwCGWySYXfYoxt00IJkTF+8Lb57DwOb3Aa0o9CApepiYQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/resolve-uri": "^3.1.0", + "@jridgewell/sourcemap-codec": "^1.4.14" + } + }, + "node_modules/@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.walk": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", + "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@pkgjs/parseargs": { + "version": "0.11.0", + "resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz", + "integrity": "sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==", + "license": "MIT", + "optional": true, + "engines": { + "node": ">=14" + } + }, + "node_modules/@rtsao/scc": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@rtsao/scc/-/scc-1.1.0.tgz", + "integrity": "sha512-zt6OdqaDoOnJ1ZYsCYGt9YmWzDXl4vQdKTyJev62gFhRGKdx7mcT54V9KIjg+d2wi9EXsPvAPKe7i7WjfVWB8g==", + "dev": true, + "license": "MIT" + }, + "node_modules/@sinclair/typebox": { + "version": "0.27.8", + "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.27.8.tgz", + "integrity": "sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@sinonjs/commons": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-3.0.1.tgz", + "integrity": "sha512-K3mCHKQ9sVh8o1C9cxkwxaOmXoAMlDxC1mYyHrjqOWEcBjYr76t96zL2zlj5dUGZ3HSw240X1qgH3Mjf1yJWpQ==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "type-detect": "4.0.8" + } + }, + "node_modules/@sinonjs/fake-timers": { + "version": "10.3.0", + "resolved": "https://registry.npmjs.org/@sinonjs/fake-timers/-/fake-timers-10.3.0.tgz", + "integrity": "sha512-V4BG07kuYSUkTCSBHG8G8TNhM+F19jXFWnQtzj+we8DrkpSBCee9Z3Ms8yiGer/dlmhe35/Xdgyo3/0rQKg7YA==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "@sinonjs/commons": "^3.0.0" + } + }, + "node_modules/@types/babel__core": { + "version": "7.20.5", + "resolved": "https://registry.npmjs.org/@types/babel__core/-/babel__core-7.20.5.tgz", + "integrity": "sha512-qoQprZvz5wQFJwMDqeseRXWv3rqMvhgpbXFfVyWhbx9X47POIA6i/+dXefEmZKoAgOaTdaIgNSMqMIU61yRyzA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.20.7", + "@babel/types": "^7.20.7", + "@types/babel__generator": "*", + "@types/babel__template": "*", + "@types/babel__traverse": "*" + } + }, + "node_modules/@types/babel__generator": { + "version": "7.6.8", + "resolved": "https://registry.npmjs.org/@types/babel__generator/-/babel__generator-7.6.8.tgz", + "integrity": "sha512-ASsj+tpEDsEiFr1arWrlN6V3mdfjRMZt6LtK/Vp/kreFLnr5QH5+DhvD5nINYZXzwJvXeGq+05iUXcAzVrqWtw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/types": "^7.0.0" + } + }, + "node_modules/@types/babel__template": { + "version": "7.4.4", + "resolved": "https://registry.npmjs.org/@types/babel__template/-/babel__template-7.4.4.tgz", + "integrity": "sha512-h/NUaSyG5EyxBIp8YRxo4RMe2/qQgvyowRwVMzhYhBCONbW8PUsg4lkFMrhgZhUe5z3L3MiLDuvyJ/CaPa2A8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.1.0", + "@babel/types": "^7.0.0" + } + }, + "node_modules/@types/babel__traverse": { + "version": "7.20.6", + "resolved": "https://registry.npmjs.org/@types/babel__traverse/-/babel__traverse-7.20.6.tgz", + "integrity": "sha512-r1bzfrm0tomOI8g1SzvCaQHo6Lcv6zu0EA+W2kHrt8dyrHQxGzBBL4kdkzIS+jBMV+EYcMAEAqXqYaLJq5rOZg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/types": "^7.20.7" + } + }, + "node_modules/@types/graceful-fs": { + "version": "4.1.9", + "resolved": "https://registry.npmjs.org/@types/graceful-fs/-/graceful-fs-4.1.9.tgz", + "integrity": "sha512-olP3sd1qOEe5dXTSaFvQG+02VdRXcdytWLAZsAq1PecU8uqQAhkrnbli7DagjtXKW/Bl7YJbUsa8MPcuc8LHEQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/istanbul-lib-coverage": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.6.tgz", + "integrity": "sha512-2QF/t/auWm0lsy8XtKVPG19v3sSOQlJe/YHZgfjb/KBBHOGSV+J2q/S671rcq9uTBrLAXmZpqJiaQbMT+zNU1w==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/istanbul-lib-report": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@types/istanbul-lib-report/-/istanbul-lib-report-3.0.3.tgz", + "integrity": "sha512-NQn7AHQnk/RSLOxrBbGyJM/aVQ+pjj5HCgasFxc0K/KhoATfQ/47AyUl15I2yBUpihjmas+a+VJBOqecrFH+uA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/istanbul-lib-coverage": "*" + } + }, + "node_modules/@types/istanbul-reports": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@types/istanbul-reports/-/istanbul-reports-3.0.4.tgz", + "integrity": "sha512-pk2B1NWalF9toCRu6gjBzR69syFjP4Od8WRAX+0mmf9lAjCRicLOWc+ZrxZHx/0XRjotgkF9t6iaMJ+aXcOdZQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/istanbul-lib-report": "*" + } + }, + "node_modules/@types/jest": { + "version": "29.5.14", + "resolved": "https://registry.npmjs.org/@types/jest/-/jest-29.5.14.tgz", + "integrity": "sha512-ZN+4sdnLUbo8EVvVc2ao0GFW6oVrQRPn4K2lglySj7APvSrgzxHiNNK99us4WDMi57xxA2yggblIAMNhXOotLQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "expect": "^29.0.0", + "pretty-format": "^29.0.0" + } + }, + "node_modules/@types/json5": { + "version": "0.0.29", + "resolved": "https://registry.npmjs.org/@types/json5/-/json5-0.0.29.tgz", + "integrity": "sha512-dRLjCWHYg4oaA77cxO64oO+7JwCwnIzkZPdrrC71jQmQtlhM556pwKo5bUzqvZndkVbeFLIIi+9TC40JNF5hNQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/moment": { + "version": "2.11.29", + "resolved": "https://registry.npmjs.org/@types/moment/-/moment-2.11.29.tgz", + "integrity": "sha512-D5WIgbLYQzvgfsDnBhZFSTnt/BjGPOE+Jsh3k1BYYijJAkrn7ceeLvU4jtjKKXXuXN42O3ARlU4D/P9ezbQYFA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/node": { + "version": "20.17.6", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.17.6.tgz", + "integrity": "sha512-VEI7OdvK2wP7XHnsuXbAJnEpEkF6NjSN45QJlL4VGqZSXsnicpesdTWsg9RISeSdYd3yeRj/y3k5KGjUXYnFwQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "undici-types": "~6.19.2" + } + }, + "node_modules/@types/pino": { + "version": "7.0.4", + "resolved": "https://registry.npmjs.org/@types/pino/-/pino-7.0.4.tgz", + "integrity": "sha512-yKw1UbZOTe7vP1xMQT+oz3FexwgIpBTrM+AC62vWgAkNRULgLTJWfYX+H5/sKPm8VXFbIcXkC3VZPyuaNioZFg==", + "dev": true, + "license": "MIT", + "dependencies": { + "pino": "*" + } + }, + "node_modules/@types/stack-utils": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/@types/stack-utils/-/stack-utils-2.0.3.tgz", + "integrity": "sha512-9aEbYZ3TbYMznPdcdr3SmIrLXwC/AKZXQeCf9Pgao5CKb8CyHuEX5jzWPTkvregvhRJHcpRO6BFoGW9ycaOkYw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/yargs": { + "version": "17.0.33", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.33.tgz", + "integrity": "sha512-WpxBCKWPLr4xSsHgz511rFJAM+wS28w2zEO1QDNY5zM/S8ok70NNfztH0xwhqKyaK0OHCbN98LDAZuy1ctxDkA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/yargs-parser": "*" + } + }, + "node_modules/@types/yargs-parser": { + "version": "21.0.3", + "resolved": "https://registry.npmjs.org/@types/yargs-parser/-/yargs-parser-21.0.3.tgz", + "integrity": "sha512-I4q9QU9MQv4oEOz4tAHJtNz1cwuLxn2F3xcc2iV5WdqLPpUnj30aUuxt1mAxYTG+oe8CZMV/+6rU4S4gRDzqtQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@typescript-eslint/eslint-plugin": { + "version": "8.13.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.13.0.tgz", + "integrity": "sha512-nQtBLiZYMUPkclSeC3id+x4uVd1SGtHuElTxL++SfP47jR0zfkZBJHc+gL4qPsgTuypz0k8Y2GheaDYn6Gy3rg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@eslint-community/regexpp": "^4.10.0", + "@typescript-eslint/scope-manager": "8.13.0", + "@typescript-eslint/type-utils": "8.13.0", + "@typescript-eslint/utils": "8.13.0", + "@typescript-eslint/visitor-keys": "8.13.0", + "graphemer": "^1.4.0", + "ignore": "^5.3.1", + "natural-compare": "^1.4.0", + "ts-api-utils": "^1.3.0" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "@typescript-eslint/parser": "^8.0.0 || ^8.0.0-alpha.0", + "eslint": "^8.57.0 || ^9.0.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/parser": { + "version": "8.13.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.13.0.tgz", + "integrity": "sha512-w0xp+xGg8u/nONcGw1UXAr6cjCPU1w0XVyBs6Zqaj5eLmxkKQAByTdV/uGgNN5tVvN/kKpoQlP2cL7R+ajZZIQ==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "@typescript-eslint/scope-manager": "8.13.0", + "@typescript-eslint/types": "8.13.0", + "@typescript-eslint/typescript-estree": "8.13.0", + "@typescript-eslint/visitor-keys": "8.13.0", + "debug": "^4.3.4" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "^8.57.0 || ^9.0.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/scope-manager": { + "version": "8.13.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.13.0.tgz", + "integrity": "sha512-XsGWww0odcUT0gJoBZ1DeulY1+jkaHUciUq4jKNv4cpInbvvrtDoyBH9rE/n2V29wQJPk8iCH1wipra9BhmiMA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@typescript-eslint/types": "8.13.0", + "@typescript-eslint/visitor-keys": "8.13.0" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/@typescript-eslint/type-utils": { + "version": "8.13.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.13.0.tgz", + "integrity": "sha512-Rqnn6xXTR316fP4D2pohZenJnp+NwQ1mo7/JM+J1LWZENSLkJI8ID8QNtlvFeb0HnFSK94D6q0cnMX6SbE5/vA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@typescript-eslint/typescript-estree": "8.13.0", + "@typescript-eslint/utils": "8.13.0", + "debug": "^4.3.4", + "ts-api-utils": "^1.3.0" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/types": { + "version": "8.13.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.13.0.tgz", + "integrity": "sha512-4cyFErJetFLckcThRUFdReWJjVsPCqyBlJTi6IDEpc1GWCIIZRFxVppjWLIMcQhNGhdWJJRYFHpHoDWvMlDzng==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/@typescript-eslint/typescript-estree": { + "version": "8.13.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.13.0.tgz", + "integrity": "sha512-v7SCIGmVsRK2Cy/LTLGN22uea6SaUIlpBcO/gnMGT/7zPtxp90bphcGf4fyrCQl3ZtiBKqVTG32hb668oIYy1g==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "@typescript-eslint/types": "8.13.0", + "@typescript-eslint/visitor-keys": "8.13.0", + "debug": "^4.3.4", + "fast-glob": "^3.3.2", + "is-glob": "^4.0.3", + "minimatch": "^9.0.4", + "semver": "^7.6.0", + "ts-api-utils": "^1.3.0" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/typescript-estree/node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/@typescript-eslint/typescript-estree/node_modules/minimatch": { + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", + "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", + "dev": true, + "license": "ISC", + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/@typescript-eslint/utils": { + "version": "8.13.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.13.0.tgz", + "integrity": "sha512-A1EeYOND6Uv250nybnLZapeXpYMl8tkzYUxqmoKAWnI4sei3ihf2XdZVd+vVOmHGcp3t+P7yRrNsyyiXTvShFQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@eslint-community/eslint-utils": "^4.4.0", + "@typescript-eslint/scope-manager": "8.13.0", + "@typescript-eslint/types": "8.13.0", + "@typescript-eslint/typescript-estree": "8.13.0" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "^8.57.0 || ^9.0.0" + } + }, + "node_modules/@typescript-eslint/visitor-keys": { + "version": "8.13.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.13.0.tgz", + "integrity": "sha512-7N/+lztJqH4Mrf0lb10R/CbI1EaAMMGyF5y0oJvFoAhafwgiRA7TXyd8TFn8FC8k5y2dTsYogg238qavRGNnlw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@typescript-eslint/types": "8.13.0", + "eslint-visitor-keys": "^3.4.3" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/@ungap/structured-clone": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.2.0.tgz", + "integrity": "sha512-zuVdFrMJiuCDQUMCzQaD6KL28MjnqqN8XnAqiEq9PNm/hCPTSGfrXCOfwj1ow4LFb/tNymJPwsNbVePc1xFqrQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/abort-controller": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/abort-controller/-/abort-controller-3.0.0.tgz", + "integrity": "sha512-h8lQ8tacZYnR3vNQTgibj+tODHI5/+l06Au2Pcriv/Gmet0eaj4TwWH41sO9wnHDiQsEj19q0drzdWdeAHtweg==", + "license": "MIT", + "dependencies": { + "event-target-shim": "^5.0.0" + }, + "engines": { + "node": ">=6.5" + } + }, + "node_modules/acorn": { + "version": "8.14.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.14.0.tgz", + "integrity": "sha512-cl669nCJTZBsL97OF4kUQm5g5hC2uihk0NxY3WENAC0TYdILVkAyHymAntgxGkl7K+t0cXIrH5siy5S4XkFycA==", + "dev": true, + "license": "MIT", + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-jsx": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", + "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" + } + }, + "node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dev": true, + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/ansi-escapes": { + "version": "4.3.2", + "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz", + "integrity": "sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "type-fest": "^0.21.3" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/ansi-escapes/node_modules/type-fest": { + "version": "0.21.3", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz", + "integrity": "sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==", + "dev": true, + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-sequence-parser": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/ansi-sequence-parser/-/ansi-sequence-parser-1.1.1.tgz", + "integrity": "sha512-vJXt3yiaUL4UU546s3rPXlsry/RnM730G1+HkpKE012AN0sx1eOrxSu95oKDIonskeLTijMgqWZ3uDEe3NFvyg==", + "dev": true, + "license": "MIT" + }, + "node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "license": "MIT", + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/anymatch": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.3.tgz", + "integrity": "sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==", + "dev": true, + "license": "ISC", + "dependencies": { + "normalize-path": "^3.0.0", + "picomatch": "^2.0.4" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true, + "license": "Python-2.0" + }, + "node_modules/array-buffer-byte-length": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/array-buffer-byte-length/-/array-buffer-byte-length-1.0.1.tgz", + "integrity": "sha512-ahC5W1xgou+KTXix4sAO8Ki12Q+jf4i0+tmk3sC+zgcynshkHxzpXdImBehiUYKKKDwvfFiJl1tZt6ewscS1Mg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.5", + "is-array-buffer": "^3.0.4" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/array-includes": { + "version": "3.1.8", + "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.8.tgz", + "integrity": "sha512-itaWrbYbqpGXkGhZPGUulwnhVf5Hpy1xiCFsGqyIGglbBxmG5vSjxQen3/WGOjPpNEv1RtBLKxbmVXm8HpJStQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-object-atoms": "^1.0.0", + "get-intrinsic": "^1.2.4", + "is-string": "^1.0.7" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/array.prototype.findlastindex": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/array.prototype.findlastindex/-/array.prototype.findlastindex-1.2.5.tgz", + "integrity": "sha512-zfETvRFA8o7EiNn++N5f/kaCw221hrpGsDmcpndVupkPzEc1Wuf3VgC0qby1BbHs7f5DVYjgtEU2LLh5bqeGfQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0", + "es-shim-unscopables": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/array.prototype.flat": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.3.2.tgz", + "integrity": "sha512-djYB+Zx2vLewY8RWlNCUdHjDXs2XOgm602S9E7P/UpHgfeHL00cRiIF+IN/G/aUJ7kGPb6yO/ErDI5V2s8iycA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.2.0", + "es-abstract": "^1.22.1", + "es-shim-unscopables": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/array.prototype.flatmap": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/array.prototype.flatmap/-/array.prototype.flatmap-1.3.2.tgz", + "integrity": "sha512-Ewyx0c9PmpcsByhSW4r+9zDU7sGjFc86qf/kKtuSCRdhfbk0SNLLkaT5qvcHnRGgc5NP/ly/y+qkXkqONX54CQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.2.0", + "es-abstract": "^1.22.1", + "es-shim-unscopables": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/arraybuffer.prototype.slice": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/arraybuffer.prototype.slice/-/arraybuffer.prototype.slice-1.0.3.tgz", + "integrity": "sha512-bMxMKAjg13EBSVscxTaYA4mRc5t1UAXa2kXiGTNfZ079HIWXEkKmkgFrh/nJqamaLSrXO5H4WFFkPEaLJWbs3A==", + "dev": true, + "license": "MIT", + "dependencies": { + "array-buffer-byte-length": "^1.0.1", + "call-bind": "^1.0.5", + "define-properties": "^1.2.1", + "es-abstract": "^1.22.3", + "es-errors": "^1.2.1", + "get-intrinsic": "^1.2.3", + "is-array-buffer": "^3.0.4", + "is-shared-array-buffer": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/async": { + "version": "3.2.6", + "resolved": "https://registry.npmjs.org/async/-/async-3.2.6.tgz", + "integrity": "sha512-htCUDlxyyCLMgaM3xXg0C0LW2xqfuQ6p05pCEIsXuyQ+a1koYKTuBMzRNwmybfLgvJDMd0r1LTn4+E0Ti6C2AA==", + "dev": true, + "license": "MIT" + }, + "node_modules/asynckit": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", + "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==", + "license": "MIT" + }, + "node_modules/atomic-sleep": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/atomic-sleep/-/atomic-sleep-1.0.0.tgz", + "integrity": "sha512-kNOjDqAh7px0XWNI+4QbzoiR/nTkHAWNud2uvnJquD1/x5a7EQZMJT0AczqK0Qn67oY/TTQ1LbUKajZpp3I9tQ==", + "license": "MIT", + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/available-typed-arrays": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.7.tgz", + "integrity": "sha512-wvUjBtSGN7+7SjNpq/9M2Tg350UZD3q62IFZLbRAR1bSMlCo1ZaeW+BJ+D090e4hIIZLBcTDWe4Mh4jvUDajzQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "possible-typed-array-names": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/axios": { + "version": "1.7.7", + "resolved": "https://registry.npmjs.org/axios/-/axios-1.7.7.tgz", + "integrity": "sha512-S4kL7XrjgBmvdGut0sN3yJxqYzrDOnivkBiN0OFs6hLiUam3UPvswUo0kqGyhqUZGEOytHyumEdXsAkgCOUf3Q==", + "license": "MIT", + "dependencies": { + "follow-redirects": "^1.15.6", + "form-data": "^4.0.0", + "proxy-from-env": "^1.1.0" + } + }, + "node_modules/babel-jest": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/babel-jest/-/babel-jest-29.7.0.tgz", + "integrity": "sha512-BrvGY3xZSwEcCzKvKsCi2GgHqDqsYkOP4/by5xCgIwGXQxIEh+8ew3gmrE1y7XRR6LHZIj6yLYnUi/mm2KXKBg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/transform": "^29.7.0", + "@types/babel__core": "^7.1.14", + "babel-plugin-istanbul": "^6.1.1", + "babel-preset-jest": "^29.6.3", + "chalk": "^4.0.0", + "graceful-fs": "^4.2.9", + "slash": "^3.0.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + }, + "peerDependencies": { + "@babel/core": "^7.8.0" + } + }, + "node_modules/babel-plugin-istanbul": { + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/babel-plugin-istanbul/-/babel-plugin-istanbul-6.1.1.tgz", + "integrity": "sha512-Y1IQok9821cC9onCx5otgFfRm7Lm+I+wwxOx738M/WLPZ9Q42m4IG5W0FNX8WLL2gYMZo3JkuXIH2DOpWM+qwA==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "@babel/helper-plugin-utils": "^7.0.0", + "@istanbuljs/load-nyc-config": "^1.0.0", + "@istanbuljs/schema": "^0.1.2", + "istanbul-lib-instrument": "^5.0.4", + "test-exclude": "^6.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/babel-plugin-istanbul/node_modules/istanbul-lib-instrument": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/istanbul-lib-instrument/-/istanbul-lib-instrument-5.2.1.tgz", + "integrity": "sha512-pzqtp31nLv/XFOzXGuvhCb8qhjmTVo5vjVk19XE4CRlSWz0KoeJ3bw9XsA7nOp9YBf4qHjwBxkDzKcME/J29Yg==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "@babel/core": "^7.12.3", + "@babel/parser": "^7.14.7", + "@istanbuljs/schema": "^0.1.2", + "istanbul-lib-coverage": "^3.2.0", + "semver": "^6.3.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/babel-plugin-istanbul/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/babel-plugin-jest-hoist": { + "version": "29.6.3", + "resolved": "https://registry.npmjs.org/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-29.6.3.tgz", + "integrity": "sha512-ESAc/RJvGTFEzRwOTT4+lNDk/GNHMkKbNzsvT0qKRfDyyYTskxB5rnU2njIDYVxXCBHHEI1c0YwHob3WaYujOg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/template": "^7.3.3", + "@babel/types": "^7.3.3", + "@types/babel__core": "^7.1.14", + "@types/babel__traverse": "^7.0.6" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/babel-preset-current-node-syntax": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/babel-preset-current-node-syntax/-/babel-preset-current-node-syntax-1.1.0.tgz", + "integrity": "sha512-ldYss8SbBlWva1bs28q78Ju5Zq1F+8BrqBZZ0VFhLBvhh6lCpC2o3gDJi/5DRLs9FgYZCnmPYIVFU4lRXCkyUw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/plugin-syntax-async-generators": "^7.8.4", + "@babel/plugin-syntax-bigint": "^7.8.3", + "@babel/plugin-syntax-class-properties": "^7.12.13", + "@babel/plugin-syntax-class-static-block": "^7.14.5", + "@babel/plugin-syntax-import-attributes": "^7.24.7", + "@babel/plugin-syntax-import-meta": "^7.10.4", + "@babel/plugin-syntax-json-strings": "^7.8.3", + "@babel/plugin-syntax-logical-assignment-operators": "^7.10.4", + "@babel/plugin-syntax-nullish-coalescing-operator": "^7.8.3", + "@babel/plugin-syntax-numeric-separator": "^7.10.4", + "@babel/plugin-syntax-object-rest-spread": "^7.8.3", + "@babel/plugin-syntax-optional-catch-binding": "^7.8.3", + "@babel/plugin-syntax-optional-chaining": "^7.8.3", + "@babel/plugin-syntax-private-property-in-object": "^7.14.5", + "@babel/plugin-syntax-top-level-await": "^7.14.5" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/babel-preset-jest": { + "version": "29.6.3", + "resolved": "https://registry.npmjs.org/babel-preset-jest/-/babel-preset-jest-29.6.3.tgz", + "integrity": "sha512-0B3bhxR6snWXJZtR/RliHTDPRgn1sNHOR0yVtq/IiQFyuOVjFS+wuio/R4gSNkyYmKmJB4wGZv2NZanmKmTnNA==", + "dev": true, + "license": "MIT", + "dependencies": { + "babel-plugin-jest-hoist": "^29.6.3", + "babel-preset-current-node-syntax": "^1.0.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "license": "MIT" + }, + "node_modules/base64-js": { + "version": "1.5.1", + "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz", + "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "node_modules/braces": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", + "dev": true, + "license": "MIT", + "dependencies": { + "fill-range": "^7.1.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/browserslist": { + "version": "4.24.2", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.24.2.tgz", + "integrity": "sha512-ZIc+Q62revdMcqC6aChtW4jz3My3klmCO1fEmINZY/8J3EpBg5/A/D0AKmBveUh6pgoeycoMkVMko84tuYS+Gg==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "caniuse-lite": "^1.0.30001669", + "electron-to-chromium": "^1.5.41", + "node-releases": "^2.0.18", + "update-browserslist-db": "^1.1.1" + }, + "bin": { + "browserslist": "cli.js" + }, + "engines": { + "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7" + } + }, + "node_modules/bs-logger": { + "version": "0.2.6", + "resolved": "https://registry.npmjs.org/bs-logger/-/bs-logger-0.2.6.tgz", + "integrity": "sha512-pd8DCoxmbgc7hyPKOvxtqNcjYoOsABPQdcCUjGp3d42VR2CX1ORhk2A87oqqu5R1kk+76nsxZupkmyd+MVtCog==", + "dev": true, + "license": "MIT", + "dependencies": { + "fast-json-stable-stringify": "2.x" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/bser": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/bser/-/bser-2.1.1.tgz", + "integrity": "sha512-gQxTNE/GAfIIrmHLUE3oJyp5FO6HRBfhjnw4/wMmA63ZGDJnWBmgY/lyQBpnDUkGmAhbSe39tx2d/iTOAfglwQ==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "node-int64": "^0.4.0" + } + }, + "node_modules/buffer": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/buffer/-/buffer-6.0.3.tgz", + "integrity": "sha512-FTiCpNxtwiZZHEZbcbTIcZjERVICn9yq/pDFkTl95/AxzD1naBctN7YO68riM/gLSDY7sdrMby8hofADYuuqOA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "dependencies": { + "base64-js": "^1.3.1", + "ieee754": "^1.2.1" + } + }, + "node_modules/buffer-from": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.2.tgz", + "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/builtins": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/builtins/-/builtins-5.1.0.tgz", + "integrity": "sha512-SW9lzGTLvWTP1AY8xeAMZimqDrIaSdLQUcVr9DMef51niJ022Ri87SwRRKYm4A6iHfkPaiVUu/Duw2Wc4J7kKg==", + "dev": true, + "license": "MIT", + "dependencies": { + "semver": "^7.0.0" + } + }, + "node_modules/call-bind": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.7.tgz", + "integrity": "sha512-GHTSNSYICQ7scH7sZ+M2rFopRoLh8t2bLSW6BbgrtLsahOIB5iyAVJf9GjWK3cYTDaMj4XdBpM1cA6pIS0Kv2w==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "set-function-length": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/callsites": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", + "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/camelcase": { + "version": "5.3.1", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", + "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/caniuse-lite": { + "version": "1.0.30001680", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001680.tgz", + "integrity": "sha512-rPQy70G6AGUMnbwS1z6Xg+RkHYPAi18ihs47GH0jcxIG7wArmPgY3XbS2sRdBbxJljp3thdT8BIqv9ccCypiPA==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/caniuse-lite" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "CC-BY-4.0" + }, + "node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/char-regex": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/char-regex/-/char-regex-1.0.2.tgz", + "integrity": "sha512-kWWXztvZ5SBQV+eRgKFeh8q5sLuZY2+8WUIzlxWVTg+oGwY14qylx1KbKzHd8P6ZYkAg0xyIDU9JMHhyJMZ1jw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/ci-info": { + "version": "3.9.0", + "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-3.9.0.tgz", + "integrity": "sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/sibiraj-s" + } + ], + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/cjs-module-lexer": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/cjs-module-lexer/-/cjs-module-lexer-1.4.1.tgz", + "integrity": "sha512-cuSVIHi9/9E/+821Qjdvngor+xpnlwnuwIyZOaLmHBVdXL+gP+I6QQB9VkO7RI77YIcTV+S1W9AreJ5eN63JBA==", + "dev": true, + "license": "MIT" + }, + "node_modules/cliui": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz", + "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==", + "dev": true, + "license": "ISC", + "dependencies": { + "string-width": "^4.2.0", + "strip-ansi": "^6.0.1", + "wrap-ansi": "^7.0.0" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/co": { + "version": "4.6.0", + "resolved": "https://registry.npmjs.org/co/-/co-4.6.0.tgz", + "integrity": "sha512-QVb0dM5HvG+uaxitm8wONl7jltx8dqhfU33DcqtOZcLSVIKSDDLDi7+0LbAKiyI8hD9u42m2YxXSkMGWThaecQ==", + "dev": true, + "license": "MIT", + "engines": { + "iojs": ">= 1.0.0", + "node": ">= 0.12.0" + } + }, + "node_modules/collect-v8-coverage": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/collect-v8-coverage/-/collect-v8-coverage-1.0.2.tgz", + "integrity": "sha512-lHl4d5/ONEbLlJvaJNtsF/Lz+WvB07u2ycqTYbdrq7UypDXailES4valYb2eWiJFxZlVmpGekfqoxQhzyFdT4Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "license": "MIT", + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "license": "MIT" + }, + "node_modules/combined-stream": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", + "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==", + "license": "MIT", + "dependencies": { + "delayed-stream": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", + "license": "MIT" + }, + "node_modules/convert-source-map": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-2.0.0.tgz", + "integrity": "sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==", + "dev": true, + "license": "MIT" + }, + "node_modules/create-jest": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/create-jest/-/create-jest-29.7.0.tgz", + "integrity": "sha512-Adz2bdH0Vq3F53KEMJOoftQFutWCukm6J24wbPWRO4k1kMY7gS7ds/uoJkNuV8wDCtWWnuwGcJwpWcih+zEW1Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^29.6.3", + "chalk": "^4.0.0", + "exit": "^0.1.2", + "graceful-fs": "^4.2.9", + "jest-config": "^29.7.0", + "jest-util": "^29.7.0", + "prompts": "^2.0.1" + }, + "bin": { + "create-jest": "bin/create-jest.js" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/cross-spawn": { + "version": "7.0.5", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.5.tgz", + "integrity": "sha512-ZVJrKKYunU38/76t0RMOulHOnUcbU9GbpWKAOZ0mhjr7CX6FVrH+4FrAapSOekrgFQ3f/8gwMEuIft0aKq6Hug==", + "license": "MIT", + "dependencies": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/data-view-buffer": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/data-view-buffer/-/data-view-buffer-1.0.1.tgz", + "integrity": "sha512-0lht7OugA5x3iJLOWFhWK/5ehONdprk0ISXqVFn/NFrDu+cuc8iADFrGQz5BnRK7LLU3JmkbXSxaqX+/mXYtUA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/data-view-byte-length": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/data-view-byte-length/-/data-view-byte-length-1.0.1.tgz", + "integrity": "sha512-4J7wRJD3ABAzr8wP+OcIcqq2dlUKp4DVflx++hs5h5ZKydWMI6/D/fAot+yh6g2tHh8fLFTvNOaVN357NvSrOQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/data-view-byte-offset": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/data-view-byte-offset/-/data-view-byte-offset-1.0.0.tgz", + "integrity": "sha512-t/Ygsytq+R995EJ5PZlD4Cu56sWa8InXySaViRzw9apusqsOO2bQP+SbYzAhR0pFKoB+43lYy8rWban9JSuXnA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/debug": { + "version": "4.3.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.7.tgz", + "integrity": "sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ==", + "license": "MIT", + "dependencies": { + "ms": "^2.1.3" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/dedent": { + "version": "1.5.3", + "resolved": "https://registry.npmjs.org/dedent/-/dedent-1.5.3.tgz", + "integrity": "sha512-NHQtfOOW68WD8lgypbLA5oT+Bt0xXJhiYvoR6SmmNXZfpzOGXwdKWmcwG8N7PwVVWV3eF/68nmD9BaJSsTBhyQ==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "babel-plugin-macros": "^3.1.0" + }, + "peerDependenciesMeta": { + "babel-plugin-macros": { + "optional": true + } + } + }, + "node_modules/deep-is": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", + "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/deepmerge": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/deepmerge/-/deepmerge-4.3.1.tgz", + "integrity": "sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/define-data-property": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", + "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "gopd": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/define-properties": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz", + "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-data-property": "^1.0.1", + "has-property-descriptors": "^1.0.0", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/delayed-stream": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", + "integrity": "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==", + "license": "MIT", + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/detect-newline": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/detect-newline/-/detect-newline-3.1.0.tgz", + "integrity": "sha512-TLz+x/vEXm/Y7P7wn1EJFNLxYpUD4TgMosxY6fAVJUnJMbupHBOncxyWUG9OpTaH9EBD7uFI5LfEgmMOc54DsA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/diff-sequences": { + "version": "29.6.3", + "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-29.6.3.tgz", + "integrity": "sha512-EjePK1srD3P08o2j4f0ExnylqRs5B9tJjcp9t1krH2qRi8CCdsYfwe9JgSLurFBWwq4uOlipzfk5fHNvwFKr8Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/doctrine": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", + "integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "esutils": "^2.0.2" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/eastasianwidth": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", + "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==", + "license": "MIT" + }, + "node_modules/ejs": { + "version": "3.1.10", + "resolved": "https://registry.npmjs.org/ejs/-/ejs-3.1.10.tgz", + "integrity": "sha512-UeJmFfOrAQS8OJWPZ4qtgHyWExa088/MtK5UEyoJGFH67cDEXkZSviOiKRCZ4Xij0zxI3JECgYs3oKx+AizQBA==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "jake": "^10.8.5" + }, + "bin": { + "ejs": "bin/cli.js" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/electron-to-chromium": { + "version": "1.5.55", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.55.tgz", + "integrity": "sha512-6maZ2ASDOTBtjt9FhqYPRnbvKU5tjG0IN9SztUOWYw2AzNDNpKJYLJmlK0/En4Hs/aiWnB+JZ+gW19PIGszgKg==", + "dev": true, + "license": "ISC" + }, + "node_modules/emittery": { + "version": "0.13.1", + "resolved": "https://registry.npmjs.org/emittery/-/emittery-0.13.1.tgz", + "integrity": "sha512-DeWwawk6r5yR9jFgnDKYt4sLS0LmHJJi3ZOnb5/JdbYwj3nW+FxQnHIjhBKz8YLC7oRNPVM9NQ47I3CVx34eqQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sindresorhus/emittery?sponsor=1" + } + }, + "node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "license": "MIT" + }, + "node_modules/error-ex": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", + "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-arrayish": "^0.2.1" + } + }, + "node_modules/es-abstract": { + "version": "1.23.3", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.23.3.tgz", + "integrity": "sha512-e+HfNH61Bj1X9/jLc5v1owaLYuHdeHHSQlkhCBiTK8rBvKaULl/beGMxwrMXjpYrv4pz22BlY570vVePA2ho4A==", + "dev": true, + "license": "MIT", + "dependencies": { + "array-buffer-byte-length": "^1.0.1", + "arraybuffer.prototype.slice": "^1.0.3", + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", + "data-view-buffer": "^1.0.1", + "data-view-byte-length": "^1.0.1", + "data-view-byte-offset": "^1.0.0", + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0", + "es-set-tostringtag": "^2.0.3", + "es-to-primitive": "^1.2.1", + "function.prototype.name": "^1.1.6", + "get-intrinsic": "^1.2.4", + "get-symbol-description": "^1.0.2", + "globalthis": "^1.0.3", + "gopd": "^1.0.1", + "has-property-descriptors": "^1.0.2", + "has-proto": "^1.0.3", + "has-symbols": "^1.0.3", + "hasown": "^2.0.2", + "internal-slot": "^1.0.7", + "is-array-buffer": "^3.0.4", + "is-callable": "^1.2.7", + "is-data-view": "^1.0.1", + "is-negative-zero": "^2.0.3", + "is-regex": "^1.1.4", + "is-shared-array-buffer": "^1.0.3", + "is-string": "^1.0.7", + "is-typed-array": "^1.1.13", + "is-weakref": "^1.0.2", + "object-inspect": "^1.13.1", + "object-keys": "^1.1.1", + "object.assign": "^4.1.5", + "regexp.prototype.flags": "^1.5.2", + "safe-array-concat": "^1.1.2", + "safe-regex-test": "^1.0.3", + "string.prototype.trim": "^1.2.9", + "string.prototype.trimend": "^1.0.8", + "string.prototype.trimstart": "^1.0.8", + "typed-array-buffer": "^1.0.2", + "typed-array-byte-length": "^1.0.1", + "typed-array-byte-offset": "^1.0.2", + "typed-array-length": "^1.0.6", + "unbox-primitive": "^1.0.2", + "which-typed-array": "^1.1.15" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/es-define-property": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.0.tgz", + "integrity": "sha512-jxayLKShrEqqzJ0eumQbVhTYQM27CfT1T35+gCgDFoL82JLsXqTJ76zv6A0YLOgEnLUMvLzsDsGIrl8NFpT2gQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "get-intrinsic": "^1.2.4" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-errors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", + "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-object-atoms": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.0.0.tgz", + "integrity": "sha512-MZ4iQ6JwHOBQjahnjwaC1ZtIBH+2ohjamzAO3oaHcXYup7qxjF2fixyH+Q71voWHeOkI2q/TnJao/KfXYIZWbw==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-set-tostringtag": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.0.3.tgz", + "integrity": "sha512-3T8uNMC3OQTHkFUsFq8r/BwAXLHvU/9O9mE0fBc/MY5iq/8H7ncvO947LmYA6ldWw9Uh8Yhf25zu6n7nML5QWQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "get-intrinsic": "^1.2.4", + "has-tostringtag": "^1.0.2", + "hasown": "^2.0.1" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-shim-unscopables": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/es-shim-unscopables/-/es-shim-unscopables-1.0.2.tgz", + "integrity": "sha512-J3yBRXCzDu4ULnQwxyToo/OjdMx6akgVC7K6few0a7F/0wLtmKKN7I73AH5T2836UuXRqN7Qg+IIUw/+YJksRw==", + "dev": true, + "license": "MIT", + "dependencies": { + "hasown": "^2.0.0" + } + }, + "node_modules/es-to-primitive": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", + "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-callable": "^1.1.4", + "is-date-object": "^1.0.1", + "is-symbol": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/escalade": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz", + "integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/escape-string-regexp": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", + "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/eslint": { + "version": "8.57.1", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.57.1.tgz", + "integrity": "sha512-ypowyDxpVSYpkXr9WPv2PAZCtNip1Mv5KTW0SCurXv/9iOpcrH9PaqUElksqEB6pChqHGDRCFTyrZlGhnLNGiA==", + "deprecated": "This version is no longer supported. Please see https://eslint.org/version-support for other options.", + "dev": true, + "license": "MIT", + "dependencies": { + "@eslint-community/eslint-utils": "^4.2.0", + "@eslint-community/regexpp": "^4.6.1", + "@eslint/eslintrc": "^2.1.4", + "@eslint/js": "8.57.1", + "@humanwhocodes/config-array": "^0.13.0", + "@humanwhocodes/module-importer": "^1.0.1", + "@nodelib/fs.walk": "^1.2.8", + "@ungap/structured-clone": "^1.2.0", + "ajv": "^6.12.4", + "chalk": "^4.0.0", + "cross-spawn": "^7.0.2", + "debug": "^4.3.2", + "doctrine": "^3.0.0", + "escape-string-regexp": "^4.0.0", + "eslint-scope": "^7.2.2", + "eslint-visitor-keys": "^3.4.3", + "espree": "^9.6.1", + "esquery": "^1.4.2", + "esutils": "^2.0.2", + "fast-deep-equal": "^3.1.3", + "file-entry-cache": "^6.0.1", + "find-up": "^5.0.0", + "glob-parent": "^6.0.2", + "globals": "^13.19.0", + "graphemer": "^1.4.0", + "ignore": "^5.2.0", + "imurmurhash": "^0.1.4", + "is-glob": "^4.0.0", + "is-path-inside": "^3.0.3", + "js-yaml": "^4.1.0", + "json-stable-stringify-without-jsonify": "^1.0.1", + "levn": "^0.4.1", + "lodash.merge": "^4.6.2", + "minimatch": "^3.1.2", + "natural-compare": "^1.4.0", + "optionator": "^0.9.3", + "strip-ansi": "^6.0.1", + "text-table": "^0.2.0" + }, + "bin": { + "eslint": "bin/eslint.js" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, + "node_modules/eslint-config-semistandard": { + "version": "17.0.0", + "resolved": "https://registry.npmjs.org/eslint-config-semistandard/-/eslint-config-semistandard-17.0.0.tgz", + "integrity": "sha512-tLi0JYmfiiJgtmRhoES55tENatR7y/5aXOh6cBeW+qjzl1+WwyV0arDqR65XN3/xrPZt+/1EG+xNLknV/0jWsQ==", + "dev": true, + "license": "ISC", + "peerDependencies": { + "eslint": "^8.13.0", + "eslint-config-standard": "^17.0.0", + "eslint-plugin-import": "^2.26.0", + "eslint-plugin-n": "^15.0.0", + "eslint-plugin-promise": "^6.0.0" + } + }, + "node_modules/eslint-config-standard": { + "version": "17.1.0", + "resolved": "https://registry.npmjs.org/eslint-config-standard/-/eslint-config-standard-17.1.0.tgz", + "integrity": "sha512-IwHwmaBNtDK4zDHQukFDW5u/aTb8+meQWZvNFWkiGmbWjD6bqyuSSBxxXKkCftCUzc1zwCH2m/baCNDLGmuO5Q==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "eslint": "^8.0.1", + "eslint-plugin-import": "^2.25.2", + "eslint-plugin-n": "^15.0.0 || ^16.0.0 ", + "eslint-plugin-promise": "^6.0.0" + } + }, + "node_modules/eslint-import-resolver-node": { + "version": "0.3.9", + "resolved": "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.9.tgz", + "integrity": "sha512-WFj2isz22JahUv+B788TlO3N6zL3nNJGU8CcZbPZvVEkBPaJdCV4vy5wyghty5ROFbCRnm132v8BScu5/1BQ8g==", + "dev": true, + "license": "MIT", + "dependencies": { + "debug": "^3.2.7", + "is-core-module": "^2.13.0", + "resolve": "^1.22.4" + } + }, + "node_modules/eslint-import-resolver-node/node_modules/debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "^2.1.1" + } + }, + "node_modules/eslint-module-utils": { + "version": "2.12.0", + "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.12.0.tgz", + "integrity": "sha512-wALZ0HFoytlyh/1+4wuZ9FJCD/leWHQzzrxJ8+rebyReSLk7LApMyd3WJaLVoN+D5+WIdJyDK1c6JnE65V4Zyg==", + "dev": true, + "license": "MIT", + "dependencies": { + "debug": "^3.2.7" + }, + "engines": { + "node": ">=4" + }, + "peerDependenciesMeta": { + "eslint": { + "optional": true + } + } + }, + "node_modules/eslint-module-utils/node_modules/debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "^2.1.1" + } + }, + "node_modules/eslint-plugin-es": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-es/-/eslint-plugin-es-4.1.0.tgz", + "integrity": "sha512-GILhQTnjYE2WorX5Jyi5i4dz5ALWxBIdQECVQavL6s7cI76IZTDWleTHkxz/QT3kvcs2QlGHvKLYsSlPOlPXnQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "eslint-utils": "^2.0.0", + "regexpp": "^3.0.0" + }, + "engines": { + "node": ">=8.10.0" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + }, + "peerDependencies": { + "eslint": ">=4.19.1" + } + }, + "node_modules/eslint-plugin-es/node_modules/eslint-utils": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", + "integrity": "sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg==", + "dev": true, + "license": "MIT", + "dependencies": { + "eslint-visitor-keys": "^1.1.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + } + }, + "node_modules/eslint-plugin-es/node_modules/eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=4" + } + }, + "node_modules/eslint-plugin-import": { + "version": "2.31.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.31.0.tgz", + "integrity": "sha512-ixmkI62Rbc2/w8Vfxyh1jQRTdRTF52VxwRVHl/ykPAmqG+Nb7/kNn+byLP0LxPgI7zWA16Jt82SybJInmMia3A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@rtsao/scc": "^1.1.0", + "array-includes": "^3.1.8", + "array.prototype.findlastindex": "^1.2.5", + "array.prototype.flat": "^1.3.2", + "array.prototype.flatmap": "^1.3.2", + "debug": "^3.2.7", + "doctrine": "^2.1.0", + "eslint-import-resolver-node": "^0.3.9", + "eslint-module-utils": "^2.12.0", + "hasown": "^2.0.2", + "is-core-module": "^2.15.1", + "is-glob": "^4.0.3", + "minimatch": "^3.1.2", + "object.fromentries": "^2.0.8", + "object.groupby": "^1.0.3", + "object.values": "^1.2.0", + "semver": "^6.3.1", + "string.prototype.trimend": "^1.0.8", + "tsconfig-paths": "^3.15.0" + }, + "engines": { + "node": ">=4" + }, + "peerDependencies": { + "eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0 || ^8 || ^9" + } + }, + "node_modules/eslint-plugin-import/node_modules/debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "^2.1.1" + } + }, + "node_modules/eslint-plugin-import/node_modules/doctrine": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", + "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "esutils": "^2.0.2" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/eslint-plugin-import/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/eslint-plugin-n": { + "version": "15.7.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-n/-/eslint-plugin-n-15.7.0.tgz", + "integrity": "sha512-jDex9s7D/Qial8AGVIHq4W7NswpUD5DPDL2RH8Lzd9EloWUuvUkHfv4FRLMipH5q2UtyurorBkPeNi1wVWNh3Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "builtins": "^5.0.1", + "eslint-plugin-es": "^4.1.0", + "eslint-utils": "^3.0.0", + "ignore": "^5.1.1", + "is-core-module": "^2.11.0", + "minimatch": "^3.1.2", + "resolve": "^1.22.1", + "semver": "^7.3.8" + }, + "engines": { + "node": ">=12.22.0" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + }, + "peerDependencies": { + "eslint": ">=7.0.0" + } + }, + "node_modules/eslint-plugin-promise": { + "version": "6.6.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-promise/-/eslint-plugin-promise-6.6.0.tgz", + "integrity": "sha512-57Zzfw8G6+Gq7axm2Pdo3gW/Rx3h9Yywgn61uE/3elTCOePEHVrn2i5CdfBwA1BLK0Q0WqctICIUSqXZW/VprQ==", + "dev": true, + "license": "ISC", + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + }, + "peerDependencies": { + "eslint": "^7.0.0 || ^8.0.0 || ^9.0.0" + } + }, + "node_modules/eslint-scope": { + "version": "7.2.2", + "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-7.2.2.tgz", + "integrity": "sha512-dOt21O7lTMhDM+X9mB4GX+DZrZtCUJPL/wlcTqxyrx5IvO0IYtILdtrQGQp+8n5S0gwSVmOf9NQrjMOgfQZlIg==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "esrecurse": "^4.3.0", + "estraverse": "^5.2.0" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, + "node_modules/eslint-utils": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-3.0.0.tgz", + "integrity": "sha512-uuQC43IGctw68pJA1RgbQS8/NP7rch6Cwd4j3ZBtgo4/8Flj4eGE7ZYSZRN3iq5pVUv6GPdW5Z1RFleo84uLDA==", + "dev": true, + "license": "MIT", + "dependencies": { + "eslint-visitor-keys": "^2.0.0" + }, + "engines": { + "node": "^10.0.0 || ^12.0.0 || >= 14.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + }, + "peerDependencies": { + "eslint": ">=5" + } + }, + "node_modules/eslint-utils/node_modules/eslint-visitor-keys": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-2.1.0.tgz", + "integrity": "sha512-0rSmRBzXgDzIsD6mGdJgevzgezI534Cer5L/vyMX0kHzT/jiB43jRhd9YUlMGYLQy2zprNmoT8qasCGtY+QaKw==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=10" + } + }, + "node_modules/eslint-visitor-keys": { + "version": "3.4.3", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", + "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, + "node_modules/espree": { + "version": "9.6.1", + "resolved": "https://registry.npmjs.org/espree/-/espree-9.6.1.tgz", + "integrity": "sha512-oruZaFkjorTpF32kDSI5/75ViwGeZginGGy2NoOSg3Q9bnwlnmDm4HLnkl0RE3n+njDXR037aY1+x58Z/zFdwQ==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "acorn": "^8.9.0", + "acorn-jsx": "^5.3.2", + "eslint-visitor-keys": "^3.4.1" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, + "node_modules/esprima": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", + "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", + "dev": true, + "license": "BSD-2-Clause", + "bin": { + "esparse": "bin/esparse.js", + "esvalidate": "bin/esvalidate.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/esquery": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.6.0.tgz", + "integrity": "sha512-ca9pw9fomFcKPvFLXhBKUK90ZvGibiGOvRJNbjljY7s7uq/5YO4BOzcYtJqExdx99rF6aAcnRxHmcUHcz6sQsg==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "estraverse": "^5.1.0" + }, + "engines": { + "node": ">=0.10" + } + }, + "node_modules/esrecurse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", + "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "estraverse": "^5.2.0" + }, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/estraverse": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", + "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=4.0" + } + }, + "node_modules/esutils": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", + "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/event-target-shim": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/event-target-shim/-/event-target-shim-5.0.1.tgz", + "integrity": "sha512-i/2XbnSz/uxRCU6+NdVJgKWDTM427+MqYbkQzD321DuCQJUqOuJKIA0IM2+W2xtYHdKOmZ4dR6fExsd4SXL+WQ==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/events": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/events/-/events-3.3.0.tgz", + "integrity": "sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==", + "license": "MIT", + "engines": { + "node": ">=0.8.x" + } + }, + "node_modules/execa": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz", + "integrity": "sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==", + "dev": true, + "license": "MIT", + "dependencies": { + "cross-spawn": "^7.0.3", + "get-stream": "^6.0.0", + "human-signals": "^2.1.0", + "is-stream": "^2.0.0", + "merge-stream": "^2.0.0", + "npm-run-path": "^4.0.1", + "onetime": "^5.1.2", + "signal-exit": "^3.0.3", + "strip-final-newline": "^2.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sindresorhus/execa?sponsor=1" + } + }, + "node_modules/exit": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/exit/-/exit-0.1.2.tgz", + "integrity": "sha512-Zk/eNKV2zbjpKzrsQ+n1G6poVbErQxJ0LBOJXaKZ1EViLzH+hrLu9cdXI4zw9dBQJslwBEpbQ2P1oS7nDxs6jQ==", + "dev": true, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/expect": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/expect/-/expect-29.7.0.tgz", + "integrity": "sha512-2Zks0hf1VLFYI1kbh0I5jP3KHHyCHpkfyHBzsSXRFgl/Bg9mWYfMW8oD+PdMPlEwy5HNsR9JutYy6pMeOh61nw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/expect-utils": "^29.7.0", + "jest-get-type": "^29.6.3", + "jest-matcher-utils": "^29.7.0", + "jest-message-util": "^29.7.0", + "jest-util": "^29.7.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/fast-deep-equal": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/fast-glob": { + "version": "3.3.2", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.2.tgz", + "integrity": "sha512-oX2ruAFQwf/Orj8m737Y5adxDQO0LAB7/S5MnxCdTNDd4p6BsyIVsv9JQsATbTSq8KHRpLwIHbVlUNatxd+1Ow==", + "dev": true, + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.2", + "merge2": "^1.3.0", + "micromatch": "^4.0.4" + }, + "engines": { + "node": ">=8.6.0" + } + }, + "node_modules/fast-glob/node_modules/glob-parent": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "dev": true, + "license": "ISC", + "dependencies": { + "is-glob": "^4.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/fast-json-stable-stringify": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", + "dev": true, + "license": "MIT" + }, + "node_modules/fast-levenshtein": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", + "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw==", + "dev": true, + "license": "MIT" + }, + "node_modules/fast-redact": { + "version": "3.5.0", + "resolved": "https://registry.npmjs.org/fast-redact/-/fast-redact-3.5.0.tgz", + "integrity": "sha512-dwsoQlS7h9hMeYUq1W++23NDcBLV4KqONnITDV9DjfS3q1SgDGVrBdvvTLUotWtPSD7asWDV9/CmsZPy8Hf70A==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/fastq": { + "version": "1.17.1", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.17.1.tgz", + "integrity": "sha512-sRVD3lWVIXWg6By68ZN7vho9a1pQcN/WBFaAAsDDFzlJjvoGx0P8z7V1t72grFJfJhu3YPZBuu25f7Kaw2jN1w==", + "dev": true, + "license": "ISC", + "dependencies": { + "reusify": "^1.0.4" + } + }, + "node_modules/fb-watchman": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/fb-watchman/-/fb-watchman-2.0.2.tgz", + "integrity": "sha512-p5161BqbuCaSnB8jIbzQHOlpgsPmK5rJVDfDKO91Axs5NC1uu3HRQm6wt9cd9/+GtQQIO53JdGXXoyDpTAsgYA==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "bser": "2.1.1" + } + }, + "node_modules/file-entry-cache": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-6.0.1.tgz", + "integrity": "sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==", + "dev": true, + "license": "MIT", + "dependencies": { + "flat-cache": "^3.0.4" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/filelist": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/filelist/-/filelist-1.0.4.tgz", + "integrity": "sha512-w1cEuf3S+DrLCQL7ET6kz+gmlJdbq9J7yXCSjK/OZCPA+qEN1WyF4ZAf0YYJa4/shHJra2t/d/r8SV4Ji+x+8Q==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "minimatch": "^5.0.1" + } + }, + "node_modules/filelist/node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/filelist/node_modules/minimatch": { + "version": "5.1.6", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz", + "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==", + "dev": true, + "license": "ISC", + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/fill-range": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", + "dev": true, + "license": "MIT", + "dependencies": { + "to-regex-range": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/find-up": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", + "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==", + "dev": true, + "license": "MIT", + "dependencies": { + "locate-path": "^6.0.0", + "path-exists": "^4.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/flat-cache": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.2.0.tgz", + "integrity": "sha512-CYcENa+FtcUKLmhhqyctpclsq7QF38pKjZHsGNiSQF5r4FtoKDWabFDl3hzaEQMvT1LHEysw5twgLvpYYb4vbw==", + "dev": true, + "license": "MIT", + "dependencies": { + "flatted": "^3.2.9", + "keyv": "^4.5.3", + "rimraf": "^3.0.2" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/flat-cache/node_modules/glob": { + "version": "7.2.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", + "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", + "deprecated": "Glob versions prior to v9 are no longer supported", + "dev": true, + "license": "ISC", + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.1.1", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/flat-cache/node_modules/rimraf": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", + "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", + "deprecated": "Rimraf versions prior to v4 are no longer supported", + "dev": true, + "license": "ISC", + "dependencies": { + "glob": "^7.1.3" + }, + "bin": { + "rimraf": "bin.js" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/flatted": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.3.1.tgz", + "integrity": "sha512-X8cqMLLie7KsNUDSdzeN8FYK9rEt4Dt67OsG/DNGnYTSDBG4uFAJFBnUeiV+zCVAvwFy56IjM9sH51jVaEhNxw==", + "dev": true, + "license": "ISC" + }, + "node_modules/follow-redirects": { + "version": "1.15.9", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.9.tgz", + "integrity": "sha512-gew4GsXizNgdoRyqmyfMHyAmXsZDk6mHkSxZFCzW9gwlbtOW44CDtYavM+y+72qD/Vq2l550kMF52DT8fOLJqQ==", + "funding": [ + { + "type": "individual", + "url": "https://github.com/sponsors/RubenVerborgh" + } + ], + "license": "MIT", + "engines": { + "node": ">=4.0" + }, + "peerDependenciesMeta": { + "debug": { + "optional": true + } + } + }, + "node_modules/for-each": { + "version": "0.3.3", + "resolved": "https://registry.npmjs.org/for-each/-/for-each-0.3.3.tgz", + "integrity": "sha512-jqYfLp7mo9vIyQf8ykW2v7A+2N4QjeCeI5+Dz9XraiO1ign81wjiH7Fb9vSOWvQfNtmSa4H2RoQTrrXivdUZmw==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-callable": "^1.1.3" + } + }, + "node_modules/foreground-child": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.3.0.tgz", + "integrity": "sha512-Ld2g8rrAyMYFXBhEqMz8ZAHBi4J4uS1i/CxGMDnjyFWddMXLVcDp051DZfu+t7+ab7Wv6SMqpWmyFIj5UbfFvg==", + "license": "ISC", + "dependencies": { + "cross-spawn": "^7.0.0", + "signal-exit": "^4.0.1" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/foreground-child/node_modules/signal-exit": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz", + "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==", + "license": "ISC", + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/form-data": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.1.tgz", + "integrity": "sha512-tzN8e4TX8+kkxGPK8D5u0FNmjPUjw3lwC9lSLxxoB/+GtsJG91CO8bSWy73APlgAZzZbXEYZJuxjkHH2w+Ezhw==", + "license": "MIT", + "dependencies": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.8", + "mime-types": "^2.1.12" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/fs": { + "version": "0.0.1-security", + "resolved": "https://registry.npmjs.org/fs/-/fs-0.0.1-security.tgz", + "integrity": "sha512-3XY9e1pP0CVEUCdj5BmfIZxRBTSDycnbqhIOGec9QYtmVH2fbLpj86CFWkrNOkt/Fvty4KZG5lTglL9j/gJ87w==", + "license": "ISC" + }, + "node_modules/fs.realpath": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", + "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==", + "dev": true, + "license": "ISC" + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/function-bind": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", + "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/function.prototype.name": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/function.prototype.name/-/function.prototype.name-1.1.6.tgz", + "integrity": "sha512-Z5kx79swU5P27WEayXM1tBi5Ze/lbIyiNgU3qyXUOf9b2rgXYyF9Dy9Cx+IQv/Lc8WCG6L82zwUPpSS9hGehIg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.2.0", + "es-abstract": "^1.22.1", + "functions-have-names": "^1.2.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/functions-have-names": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/functions-have-names/-/functions-have-names-1.2.3.tgz", + "integrity": "sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/gensync": { + "version": "1.0.0-beta.2", + "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", + "integrity": "sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/get-caller-file": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", + "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", + "dev": true, + "license": "ISC", + "engines": { + "node": "6.* || 8.* || >= 10.*" + } + }, + "node_modules/get-intrinsic": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.2.4.tgz", + "integrity": "sha512-5uYhsJH8VJBTv7oslg4BznJYhDoRI6waYCxMmCdnTrcCrHA/fCFKoTFz2JKKE0HdDFUF7/oQuhzumXJK7paBRQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "has-proto": "^1.0.1", + "has-symbols": "^1.0.3", + "hasown": "^2.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-package-type": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/get-package-type/-/get-package-type-0.1.0.tgz", + "integrity": "sha512-pjzuKtY64GYfWizNAJ0fr9VqttZkNiK2iS430LtIHzjBEr6bX8Am2zm4sW4Ro5wjWW5cAlRL1qAMTcXbjNAO2Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/get-stream": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz", + "integrity": "sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/get-symbol-description": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.0.2.tgz", + "integrity": "sha512-g0QYk1dZBxGwk+Ngc+ltRH2IBp2f7zBkBMBJZCDerh6EhlhSR6+9irMCuT/09zD6qkarHUSn529sK/yL4S27mg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.5", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.4" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/glob": { + "version": "10.4.5", + "resolved": "https://registry.npmjs.org/glob/-/glob-10.4.5.tgz", + "integrity": "sha512-7Bv8RF0k6xjo7d4A/PxYLbUCfb6c+Vpd2/mB2yRDlew7Jb5hEXiCD9ibfO7wpk8i4sevK6DFny9h7EYbM3/sHg==", + "license": "ISC", + "dependencies": { + "foreground-child": "^3.1.0", + "jackspeak": "^3.1.2", + "minimatch": "^9.0.4", + "minipass": "^7.1.2", + "package-json-from-dist": "^1.0.0", + "path-scurry": "^1.11.1" + }, + "bin": { + "glob": "dist/esm/bin.mjs" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/glob-parent": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-6.0.2.tgz", + "integrity": "sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==", + "dev": true, + "license": "ISC", + "dependencies": { + "is-glob": "^4.0.3" + }, + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/glob/node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/glob/node_modules/minimatch": { + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", + "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", + "license": "ISC", + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/glob/node_modules/minipass": { + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.1.2.tgz", + "integrity": "sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw==", + "license": "ISC", + "engines": { + "node": ">=16 || 14 >=14.17" + } + }, + "node_modules/globals": { + "version": "13.24.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-13.24.0.tgz", + "integrity": "sha512-AhO5QUcj8llrbG09iWhPU2B204J1xnPeL8kQmVorSsy+Sjj1sk8gIyh6cUocGmH4L0UuhAJy+hJMRA4mgA4mFQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "type-fest": "^0.20.2" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/globalthis": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/globalthis/-/globalthis-1.0.4.tgz", + "integrity": "sha512-DpLKbNU4WylpxJykQujfCcwYWiV/Jhm50Goo0wrVILAv5jOr9d+H+UR3PhSCD2rCCEIg0uc+G+muBTwD54JhDQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-properties": "^1.2.1", + "gopd": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/gopd": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.0.1.tgz", + "integrity": "sha512-d65bNlIadxvpb/A2abVdlqKqV563juRnZ1Wtk6s1sIR8uNsXR70xqIzVqxVf1eTqDunwT2MkczEeaezCKTZhwA==", + "dev": true, + "license": "MIT", + "dependencies": { + "get-intrinsic": "^1.1.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/graceful-fs": { + "version": "4.2.11", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", + "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/graphemer": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/graphemer/-/graphemer-1.4.0.tgz", + "integrity": "sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag==", + "dev": true, + "license": "MIT" + }, + "node_modules/handlebars": { + "version": "4.7.8", + "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.8.tgz", + "integrity": "sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "minimist": "^1.2.5", + "neo-async": "^2.6.2", + "source-map": "^0.6.1", + "wordwrap": "^1.0.0" + }, + "bin": { + "handlebars": "bin/handlebars" + }, + "engines": { + "node": ">=0.4.7" + }, + "optionalDependencies": { + "uglify-js": "^3.1.4" + } + }, + "node_modules/has-bigints": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.2.tgz", + "integrity": "sha512-tSvCKtBr9lkF0Ex0aQiP9N+OpV4zi2r/Nee5VkRDbaqv35RLYMzbwQfFSZZH0kR+Rd6302UJZ2p/bJCEoR3VoQ==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/has-property-descriptors": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", + "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-proto": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has-proto/-/has-proto-1.0.3.tgz", + "integrity": "sha512-SJ1amZAJUiZS+PhsVLf5tGydlaVB8EdFpaSO4gmiUKUOxk8qzn5AIy4ZeJUmh22znIdk/uMAUT2pl3FxzVUH+Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-symbols": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.3.tgz", + "integrity": "sha512-l3LCuF6MgDNwTDKkdYGEihYjt5pRPbEg46rtlmnSPlUbgmB8LOIrKJbYYFBSbnPaJexMKtiPO8hmeRjRz2Td+A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-tostringtag": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz", + "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-symbols": "^1.0.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/hasown": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", + "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/html-escaper": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz", + "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", + "dev": true, + "license": "MIT" + }, + "node_modules/https": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/https/-/https-1.0.0.tgz", + "integrity": "sha512-4EC57ddXrkaF0x83Oj8sM6SLQHAWXw90Skqu2M4AEWENZ3F02dFJE/GARA8igO79tcgYqGrD7ae4f5L3um2lgg==", + "license": "ISC" + }, + "node_modules/human-signals": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz", + "integrity": "sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=10.17.0" + } + }, + "node_modules/ieee754": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz", + "integrity": "sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "BSD-3-Clause" + }, + "node_modules/ignore": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz", + "integrity": "sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 4" + } + }, + "node_modules/import-fresh": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", + "integrity": "sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==", + "dev": true, + "license": "MIT", + "dependencies": { + "parent-module": "^1.0.0", + "resolve-from": "^4.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/import-local": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/import-local/-/import-local-3.2.0.tgz", + "integrity": "sha512-2SPlun1JUPWoM6t3F0dw0FkCF/jWY8kttcY4f599GLTSjh2OCuuhdTkJQsEcZzBqbXZGKMK2OqW1oZsjtf/gQA==", + "dev": true, + "license": "MIT", + "dependencies": { + "pkg-dir": "^4.2.0", + "resolve-cwd": "^3.0.0" + }, + "bin": { + "import-local-fixture": "fixtures/cli.js" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/imurmurhash": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", + "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.8.19" + } + }, + "node_modules/inflight": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", + "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==", + "deprecated": "This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.", + "dev": true, + "license": "ISC", + "dependencies": { + "once": "^1.3.0", + "wrappy": "1" + } + }, + "node_modules/inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/internal-slot": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.7.tgz", + "integrity": "sha512-NGnrKwXzSms2qUUih/ILZ5JBqNTSa1+ZmP6flaIp6KmSElgE9qdndzS3cqjrDovwFdmwsGsLdeFgB6suw+1e9g==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "hasown": "^2.0.0", + "side-channel": "^1.0.4" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/is-array-buffer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.4.tgz", + "integrity": "sha512-wcjaerHw0ydZwfhiKbXJWLDY8A7yV7KhjQOpb83hGgGfId/aQa4TOvwyzn2PuswW2gPCYEL/nEAiSVpdOj1lXw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "get-intrinsic": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-arrayish": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", + "integrity": "sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==", + "dev": true, + "license": "MIT" + }, + "node_modules/is-bigint": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.0.4.tgz", + "integrity": "sha512-zB9CruMamjym81i2JZ3UMn54PKGsQzsJeo6xvN3HJJ4CAsQNB6iRutp2To77OfCNuoxspsIhzaPoO1zyCEhFOg==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-bigints": "^1.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-boolean-object": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.1.2.tgz", + "integrity": "sha512-gDYaKHJmnj4aWxyj6YHyXVpdQawtVLHU5cb+eztPGczf6cjuTdwve5ZIEfgXqH4e57An1D1AKf8CZ3kYrQRqYA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-callable": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz", + "integrity": "sha512-1BC0BVFhS/p0qtw6enp8e+8OD0UrK0oFLztSjNzhcKA3WDuJxxAPXzPuPtKkjEY9UUoEWlX/8fgKeu2S8i9JTA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-core-module": { + "version": "2.15.1", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.15.1.tgz", + "integrity": "sha512-z0vtXSwucUJtANQWldhbtbt7BnL0vxiFjIdDLAatwhDYty2bad6s+rijD6Ri4YuYJubLzIJLUidCh09e1djEVQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "hasown": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-data-view": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-data-view/-/is-data-view-1.0.1.tgz", + "integrity": "sha512-AHkaJrsUVW6wq6JS8y3JnM/GJF/9cf+k20+iDzlSaJrinEo5+7vRiteOSwBhHRiAyQATN1AmY4hwzxJKPmYf+w==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-date-object": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.5.tgz", + "integrity": "sha512-9YQaSxsAiSwcvS33MBk3wTCVnWK+HhF8VZR2jRxehM16QcVOdHqPn4VPHmRK4lSr38n9JriurInLcP90xsYNfQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/is-generator-fn": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/is-generator-fn/-/is-generator-fn-2.1.0.tgz", + "integrity": "sha512-cTIB4yPYL/Grw0EaSzASzg6bBy9gqCofvWN8okThAYIxKJZC+udlRAmGbM0XLeniEJSs8uEgHPGuHSe1XsOLSQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/is-glob": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", + "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-extglob": "^2.1.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-negative-zero": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.3.tgz", + "integrity": "sha512-5KoIu2Ngpyek75jXodFvnafB6DJgr3u8uuK0LEZJjrU19DrMD3EVERaR8sjz8CCGgpZvxPl9SuE1GMVPFHx1mw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/is-number-object": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.7.tgz", + "integrity": "sha512-k1U0IRzLMo7ZlYIfzRu23Oh6MiIFasgpb9X76eqfFZAqwH44UI4KTBvBYIZ1dSL9ZzChTB9ShHfLkR4pdW5krQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-path-inside": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.3.tgz", + "integrity": "sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/is-regex": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.4.tgz", + "integrity": "sha512-kvRdxDsxZjhzUX07ZnLydzS1TU/TJlTUHHY4YLL87e37oUA49DfkLqgy+VjFocowy29cKvcSiu+kIv728jTTVg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-shared-array-buffer": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.3.tgz", + "integrity": "sha512-nA2hv5XIhLR3uVzDDfCIknerhx8XUKnstuOERPNNIinXG7v9u+ohXF67vxm4TPTEPU6lm61ZkwP3c9PCB97rhg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-stream": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", + "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-string": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.0.7.tgz", + "integrity": "sha512-tE2UXzivje6ofPW7l23cjDOMa09gb7xlAqG6jG5ej6uPV32TlWP3NKPigtaGeHNu9fohccRYvIiZMfOOnOYUtg==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-symbol": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.4.tgz", + "integrity": "sha512-C/CPBqKWnvdcxqIARxyOh4v1UUEOCHpgDa0WYgpKDFMszcrPcffg5uhwSgPCLD2WWxmq6isisz87tzT01tuGhg==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-symbols": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-typed-array": { + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/is-typed-array/-/is-typed-array-1.1.13.tgz", + "integrity": "sha512-uZ25/bUAlUY5fR4OKT4rZQEBrzQWYV9ZJYGGsUmEJ6thodVJ1HX64ePQ6Z0qPWP+m+Uq6e9UugrE38jeYsDSMw==", + "dev": true, + "license": "MIT", + "dependencies": { + "which-typed-array": "^1.1.14" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-weakref": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-weakref/-/is-weakref-1.0.2.tgz", + "integrity": "sha512-qctsuLZmIQ0+vSSMfoVvyFe2+GSEvnmZ2ezTup1SBse9+twCCeial6EEi3Nc2KFcf6+qz2FBPnjXsk8xhKSaPQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/isarray": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", + "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", + "dev": true, + "license": "MIT" + }, + "node_modules/isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", + "license": "ISC" + }, + "node_modules/istanbul-lib-coverage": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/istanbul-lib-coverage/-/istanbul-lib-coverage-3.2.2.tgz", + "integrity": "sha512-O8dpsF+r0WV/8MNRKfnmrtCWhuKjxrq2w+jpzBL5UZKTi2LeVWnWOmWRxFlesJONmc+wLAGvKQZEOanko0LFTg==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=8" + } + }, + "node_modules/istanbul-lib-instrument": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/istanbul-lib-instrument/-/istanbul-lib-instrument-6.0.3.tgz", + "integrity": "sha512-Vtgk7L/R2JHyyGW07spoFlB8/lpjiOLTjMdms6AFMraYt3BaJauod/NGrfnVG/y4Ix1JEuMRPDPEj2ua+zz1/Q==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "@babel/core": "^7.23.9", + "@babel/parser": "^7.23.9", + "@istanbuljs/schema": "^0.1.3", + "istanbul-lib-coverage": "^3.2.0", + "semver": "^7.5.4" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/istanbul-lib-report": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/istanbul-lib-report/-/istanbul-lib-report-3.0.1.tgz", + "integrity": "sha512-GCfE1mtsHGOELCU8e/Z7YWzpmybrx/+dSTfLrvY8qRmaY6zXTKWn6WQIjaAFw069icm6GVMNkgu0NzI4iPZUNw==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "istanbul-lib-coverage": "^3.0.0", + "make-dir": "^4.0.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/istanbul-lib-source-maps": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/istanbul-lib-source-maps/-/istanbul-lib-source-maps-4.0.1.tgz", + "integrity": "sha512-n3s8EwkdFIJCG3BPKBYvskgXGoy88ARzvegkitk60NxRdwltLOTaH7CUiMRXvwYorl0Q712iEjcWB+fK/MrWVw==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "debug": "^4.1.1", + "istanbul-lib-coverage": "^3.0.0", + "source-map": "^0.6.1" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/istanbul-reports": { + "version": "3.1.7", + "resolved": "https://registry.npmjs.org/istanbul-reports/-/istanbul-reports-3.1.7.tgz", + "integrity": "sha512-BewmUXImeuRk2YY0PVbxgKAysvhRPUQE0h5QRM++nVWyubKGV0l8qQ5op8+B2DOmwSe63Jivj0BjkPQVf8fP5g==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "html-escaper": "^2.0.0", + "istanbul-lib-report": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/jackspeak": { + "version": "3.4.3", + "resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-3.4.3.tgz", + "integrity": "sha512-OGlZQpz2yfahA/Rd1Y8Cd9SIEsqvXkLVoSw/cgwhnhFMDbsQFeZYoJJ7bIZBS9BcamUW96asq/npPWugM+RQBw==", + "license": "BlueOak-1.0.0", + "dependencies": { + "@isaacs/cliui": "^8.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + }, + "optionalDependencies": { + "@pkgjs/parseargs": "^0.11.0" + } + }, + "node_modules/jake": { + "version": "10.9.2", + "resolved": "https://registry.npmjs.org/jake/-/jake-10.9.2.tgz", + "integrity": "sha512-2P4SQ0HrLQ+fw6llpLnOaGAvN2Zu6778SJMrCUwns4fOoG9ayrTiZk3VV8sCPkVZF8ab0zksVpS8FDY5pRCNBA==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "async": "^3.2.3", + "chalk": "^4.0.2", + "filelist": "^1.0.4", + "minimatch": "^3.1.2" + }, + "bin": { + "jake": "bin/cli.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/jest": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest/-/jest-29.7.0.tgz", + "integrity": "sha512-NIy3oAFp9shda19hy4HK0HRTWKtPJmGdnvywu01nOqNC2vZg+Z+fvJDxpMQA88eb2I9EcafcdjYgsDthnYTvGw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/core": "^29.7.0", + "@jest/types": "^29.6.3", + "import-local": "^3.0.2", + "jest-cli": "^29.7.0" + }, + "bin": { + "jest": "bin/jest.js" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + }, + "peerDependencies": { + "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" + }, + "peerDependenciesMeta": { + "node-notifier": { + "optional": true + } + } + }, + "node_modules/jest-changed-files": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-changed-files/-/jest-changed-files-29.7.0.tgz", + "integrity": "sha512-fEArFiwf1BpQ+4bXSprcDc3/x4HSzL4al2tozwVpDFpsxALjLYdyiIK4e5Vz66GQJIbXJ82+35PtysofptNX2w==", + "dev": true, + "license": "MIT", + "dependencies": { + "execa": "^5.0.0", + "jest-util": "^29.7.0", + "p-limit": "^3.1.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-circus": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-circus/-/jest-circus-29.7.0.tgz", + "integrity": "sha512-3E1nCMgipcTkCocFwM90XXQab9bS+GMsjdpmPrlelaxwD93Ad8iVEjX/vvHPdLPnFf+L40u+5+iutRdA1N9myw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/environment": "^29.7.0", + "@jest/expect": "^29.7.0", + "@jest/test-result": "^29.7.0", + "@jest/types": "^29.6.3", + "@types/node": "*", + "chalk": "^4.0.0", + "co": "^4.6.0", + "dedent": "^1.0.0", + "is-generator-fn": "^2.0.0", + "jest-each": "^29.7.0", + "jest-matcher-utils": "^29.7.0", + "jest-message-util": "^29.7.0", + "jest-runtime": "^29.7.0", + "jest-snapshot": "^29.7.0", + "jest-util": "^29.7.0", + "p-limit": "^3.1.0", + "pretty-format": "^29.7.0", + "pure-rand": "^6.0.0", + "slash": "^3.0.0", + "stack-utils": "^2.0.3" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-cli": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-cli/-/jest-cli-29.7.0.tgz", + "integrity": "sha512-OVVobw2IubN/GSYsxETi+gOe7Ka59EFMR/twOU3Jb2GnKKeMGJB5SGUUrEz3SFVmJASUdZUzy83sLNNQ2gZslg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/core": "^29.7.0", + "@jest/test-result": "^29.7.0", + "@jest/types": "^29.6.3", + "chalk": "^4.0.0", + "create-jest": "^29.7.0", + "exit": "^0.1.2", + "import-local": "^3.0.2", + "jest-config": "^29.7.0", + "jest-util": "^29.7.0", + "jest-validate": "^29.7.0", + "yargs": "^17.3.1" + }, + "bin": { + "jest": "bin/jest.js" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + }, + "peerDependencies": { + "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" + }, + "peerDependenciesMeta": { + "node-notifier": { + "optional": true + } + } + }, + "node_modules/jest-config": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-config/-/jest-config-29.7.0.tgz", + "integrity": "sha512-uXbpfeQ7R6TZBqI3/TxCU4q4ttk3u0PJeC+E0zbfSoSjq6bJ7buBPxzQPL0ifrkY4DNu4JUdk0ImlBUYi840eQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/core": "^7.11.6", + "@jest/test-sequencer": "^29.7.0", + "@jest/types": "^29.6.3", + "babel-jest": "^29.7.0", + "chalk": "^4.0.0", + "ci-info": "^3.2.0", + "deepmerge": "^4.2.2", + "glob": "^7.1.3", + "graceful-fs": "^4.2.9", + "jest-circus": "^29.7.0", + "jest-environment-node": "^29.7.0", + "jest-get-type": "^29.6.3", + "jest-regex-util": "^29.6.3", + "jest-resolve": "^29.7.0", + "jest-runner": "^29.7.0", + "jest-util": "^29.7.0", + "jest-validate": "^29.7.0", + "micromatch": "^4.0.4", + "parse-json": "^5.2.0", + "pretty-format": "^29.7.0", + "slash": "^3.0.0", + "strip-json-comments": "^3.1.1" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + }, + "peerDependencies": { + "@types/node": "*", + "ts-node": ">=9.0.0" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + }, + "ts-node": { + "optional": true + } + } + }, + "node_modules/jest-config/node_modules/glob": { + "version": "7.2.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", + "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", + "deprecated": "Glob versions prior to v9 are no longer supported", + "dev": true, + "license": "ISC", + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.1.1", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/jest-diff": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-diff/-/jest-diff-29.7.0.tgz", + "integrity": "sha512-LMIgiIrhigmPrs03JHpxUh2yISK3vLFPkAodPeo0+BuF7wA2FoQbkEg1u8gBYBThncu7e1oEDUfIXVuTqLRUjw==", + "dev": true, + "license": "MIT", + "dependencies": { + "chalk": "^4.0.0", + "diff-sequences": "^29.6.3", + "jest-get-type": "^29.6.3", + "pretty-format": "^29.7.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-docblock": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-docblock/-/jest-docblock-29.7.0.tgz", + "integrity": "sha512-q617Auw3A612guyaFgsbFeYpNP5t2aoUNLwBUbc/0kD1R4t9ixDbyFTHd1nok4epoVFpr7PmeWHrhvuV3XaJ4g==", + "dev": true, + "license": "MIT", + "dependencies": { + "detect-newline": "^3.0.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-each": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-each/-/jest-each-29.7.0.tgz", + "integrity": "sha512-gns+Er14+ZrEoC5fhOfYCY1LOHHr0TI+rQUHZS8Ttw2l7gl+80eHc/gFf2Ktkw0+SIACDTeWvpFcv3B04VembQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^29.6.3", + "chalk": "^4.0.0", + "jest-get-type": "^29.6.3", + "jest-util": "^29.7.0", + "pretty-format": "^29.7.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-environment-node": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-environment-node/-/jest-environment-node-29.7.0.tgz", + "integrity": "sha512-DOSwCRqXirTOyheM+4d5YZOrWcdu0LNZ87ewUoywbcb2XR4wKgqiG8vNeYwhjFMbEkfju7wx2GYH0P2gevGvFw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/environment": "^29.7.0", + "@jest/fake-timers": "^29.7.0", + "@jest/types": "^29.6.3", + "@types/node": "*", + "jest-mock": "^29.7.0", + "jest-util": "^29.7.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-get-type": { + "version": "29.6.3", + "resolved": "https://registry.npmjs.org/jest-get-type/-/jest-get-type-29.6.3.tgz", + "integrity": "sha512-zrteXnqYxfQh7l5FHyL38jL39di8H8rHoecLH3JNxH3BwOrBsNeabdap5e0I23lD4HHI8W5VFBZqG4Eaq5LNcw==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-haste-map": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-haste-map/-/jest-haste-map-29.7.0.tgz", + "integrity": "sha512-fP8u2pyfqx0K1rGn1R9pyE0/KTn+G7PxktWidOBTqFPLYX0b9ksaMFkhK5vrS3DVun09pckLdlx90QthlW7AmA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^29.6.3", + "@types/graceful-fs": "^4.1.3", + "@types/node": "*", + "anymatch": "^3.0.3", + "fb-watchman": "^2.0.0", + "graceful-fs": "^4.2.9", + "jest-regex-util": "^29.6.3", + "jest-util": "^29.7.0", + "jest-worker": "^29.7.0", + "micromatch": "^4.0.4", + "walker": "^1.0.8" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + }, + "optionalDependencies": { + "fsevents": "^2.3.2" + } + }, + "node_modules/jest-leak-detector": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-leak-detector/-/jest-leak-detector-29.7.0.tgz", + "integrity": "sha512-kYA8IJcSYtST2BY9I+SMC32nDpBT3J2NvWJx8+JCuCdl/CR1I4EKUJROiP8XtCcxqgTTBGJNdbB1A8XRKbTetw==", + "dev": true, + "license": "MIT", + "dependencies": { + "jest-get-type": "^29.6.3", + "pretty-format": "^29.7.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-matcher-utils": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-matcher-utils/-/jest-matcher-utils-29.7.0.tgz", + "integrity": "sha512-sBkD+Xi9DtcChsI3L3u0+N0opgPYnCRPtGcQYrgXmR+hmt/fYfWAL0xRXYU8eWOdfuLgBe0YCW3AFtnRLagq/g==", + "dev": true, + "license": "MIT", + "dependencies": { + "chalk": "^4.0.0", + "jest-diff": "^29.7.0", + "jest-get-type": "^29.6.3", + "pretty-format": "^29.7.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-message-util": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.7.0.tgz", + "integrity": "sha512-GBEV4GRADeP+qtB2+6u61stea8mGcOT4mCtrYISZwfu9/ISHFJ/5zOMXYbpBE9RsS5+Gb63DW4FgmnKJ79Kf6w==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.12.13", + "@jest/types": "^29.6.3", + "@types/stack-utils": "^2.0.0", + "chalk": "^4.0.0", + "graceful-fs": "^4.2.9", + "micromatch": "^4.0.4", + "pretty-format": "^29.7.0", + "slash": "^3.0.0", + "stack-utils": "^2.0.3" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-mock": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-29.7.0.tgz", + "integrity": "sha512-ITOMZn+UkYS4ZFh83xYAOzWStloNzJFO2s8DWrE4lhtGD+AorgnbkiKERe4wQVBydIGPx059g6riW5Btp6Llnw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^29.6.3", + "@types/node": "*", + "jest-util": "^29.7.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-pnp-resolver": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/jest-pnp-resolver/-/jest-pnp-resolver-1.2.3.tgz", + "integrity": "sha512-+3NpwQEnRoIBtx4fyhblQDPgJI0H1IEIkX7ShLUjPGA7TtUTvI1oiKi3SR4oBR0hQhQR80l4WAe5RrXBwWMA8w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + }, + "peerDependencies": { + "jest-resolve": "*" + }, + "peerDependenciesMeta": { + "jest-resolve": { + "optional": true + } + } + }, + "node_modules/jest-regex-util": { + "version": "29.6.3", + "resolved": "https://registry.npmjs.org/jest-regex-util/-/jest-regex-util-29.6.3.tgz", + "integrity": "sha512-KJJBsRCyyLNWCNBOvZyRDnAIfUiRJ8v+hOBQYGn8gDyF3UegwiP4gwRR3/SDa42g1YbVycTidUF3rKjyLFDWbg==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-resolve": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-resolve/-/jest-resolve-29.7.0.tgz", + "integrity": "sha512-IOVhZSrg+UvVAshDSDtHyFCCBUl/Q3AAJv8iZ6ZjnZ74xzvwuzLXid9IIIPgTnY62SJjfuupMKZsZQRsCvxEgA==", + "dev": true, + "license": "MIT", + "dependencies": { + "chalk": "^4.0.0", + "graceful-fs": "^4.2.9", + "jest-haste-map": "^29.7.0", + "jest-pnp-resolver": "^1.2.2", + "jest-util": "^29.7.0", + "jest-validate": "^29.7.0", + "resolve": "^1.20.0", + "resolve.exports": "^2.0.0", + "slash": "^3.0.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-resolve-dependencies": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-resolve-dependencies/-/jest-resolve-dependencies-29.7.0.tgz", + "integrity": "sha512-un0zD/6qxJ+S0et7WxeI3H5XSe9lTBBR7bOHCHXkKR6luG5mwDDlIzVQ0V5cZCuoTgEdcdwzTghYkTWfubi+nA==", + "dev": true, + "license": "MIT", + "dependencies": { + "jest-regex-util": "^29.6.3", + "jest-snapshot": "^29.7.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-runner": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-runner/-/jest-runner-29.7.0.tgz", + "integrity": "sha512-fsc4N6cPCAahybGBfTRcq5wFR6fpLznMg47sY5aDpsoejOcVYFb07AHuSnR0liMcPTgBsA3ZJL6kFOjPdoNipQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/console": "^29.7.0", + "@jest/environment": "^29.7.0", + "@jest/test-result": "^29.7.0", + "@jest/transform": "^29.7.0", + "@jest/types": "^29.6.3", + "@types/node": "*", + "chalk": "^4.0.0", + "emittery": "^0.13.1", + "graceful-fs": "^4.2.9", + "jest-docblock": "^29.7.0", + "jest-environment-node": "^29.7.0", + "jest-haste-map": "^29.7.0", + "jest-leak-detector": "^29.7.0", + "jest-message-util": "^29.7.0", + "jest-resolve": "^29.7.0", + "jest-runtime": "^29.7.0", + "jest-util": "^29.7.0", + "jest-watcher": "^29.7.0", + "jest-worker": "^29.7.0", + "p-limit": "^3.1.0", + "source-map-support": "0.5.13" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-runtime": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-runtime/-/jest-runtime-29.7.0.tgz", + "integrity": "sha512-gUnLjgwdGqW7B4LvOIkbKs9WGbn+QLqRQQ9juC6HndeDiezIwhDP+mhMwHWCEcfQ5RUXa6OPnFF8BJh5xegwwQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/environment": "^29.7.0", + "@jest/fake-timers": "^29.7.0", + "@jest/globals": "^29.7.0", + "@jest/source-map": "^29.6.3", + "@jest/test-result": "^29.7.0", + "@jest/transform": "^29.7.0", + "@jest/types": "^29.6.3", + "@types/node": "*", + "chalk": "^4.0.0", + "cjs-module-lexer": "^1.0.0", + "collect-v8-coverage": "^1.0.0", + "glob": "^7.1.3", + "graceful-fs": "^4.2.9", + "jest-haste-map": "^29.7.0", + "jest-message-util": "^29.7.0", + "jest-mock": "^29.7.0", + "jest-regex-util": "^29.6.3", + "jest-resolve": "^29.7.0", + "jest-snapshot": "^29.7.0", + "jest-util": "^29.7.0", + "slash": "^3.0.0", + "strip-bom": "^4.0.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-runtime/node_modules/glob": { + "version": "7.2.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", + "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", + "deprecated": "Glob versions prior to v9 are no longer supported", + "dev": true, + "license": "ISC", + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.1.1", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/jest-snapshot": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-snapshot/-/jest-snapshot-29.7.0.tgz", + "integrity": "sha512-Rm0BMWtxBcioHr1/OX5YCP8Uov4riHvKPknOGs804Zg9JGZgmIBkbtlxJC/7Z4msKYVbIJtfU+tKb8xlYNfdkw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/core": "^7.11.6", + "@babel/generator": "^7.7.2", + "@babel/plugin-syntax-jsx": "^7.7.2", + "@babel/plugin-syntax-typescript": "^7.7.2", + "@babel/types": "^7.3.3", + "@jest/expect-utils": "^29.7.0", + "@jest/transform": "^29.7.0", + "@jest/types": "^29.6.3", + "babel-preset-current-node-syntax": "^1.0.0", + "chalk": "^4.0.0", + "expect": "^29.7.0", + "graceful-fs": "^4.2.9", + "jest-diff": "^29.7.0", + "jest-get-type": "^29.6.3", + "jest-matcher-utils": "^29.7.0", + "jest-message-util": "^29.7.0", + "jest-util": "^29.7.0", + "natural-compare": "^1.4.0", + "pretty-format": "^29.7.0", + "semver": "^7.5.3" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-util": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.7.0.tgz", + "integrity": "sha512-z6EbKajIpqGKU56y5KBUgy1dt1ihhQJgWzUlZHArA/+X2ad7Cb5iF+AK1EWVL/Bo7Rz9uurpqw6SiBCefUbCGA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^29.6.3", + "@types/node": "*", + "chalk": "^4.0.0", + "ci-info": "^3.2.0", + "graceful-fs": "^4.2.9", + "picomatch": "^2.2.3" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-validate": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-validate/-/jest-validate-29.7.0.tgz", + "integrity": "sha512-ZB7wHqaRGVw/9hST/OuFUReG7M8vKeq0/J2egIGLdvjHCmYqGARhzXmtgi+gVeZ5uXFF219aOc3Ls2yLg27tkw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^29.6.3", + "camelcase": "^6.2.0", + "chalk": "^4.0.0", + "jest-get-type": "^29.6.3", + "leven": "^3.1.0", + "pretty-format": "^29.7.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-validate/node_modules/camelcase": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-6.3.0.tgz", + "integrity": "sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/jest-watcher": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-watcher/-/jest-watcher-29.7.0.tgz", + "integrity": "sha512-49Fg7WXkU3Vl2h6LbLtMQ/HyB6rXSIX7SqvBLQmssRBGN9I0PNvPmAmCWSOY6SOvrjhI/F7/bGAv9RtnsPA03g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/test-result": "^29.7.0", + "@jest/types": "^29.6.3", + "@types/node": "*", + "ansi-escapes": "^4.2.1", + "chalk": "^4.0.0", + "emittery": "^0.13.1", + "jest-util": "^29.7.0", + "string-length": "^4.0.1" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-worker": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-29.7.0.tgz", + "integrity": "sha512-eIz2msL/EzL9UFTFFx7jBTkeZfku0yUAyZZZmJ93H2TYEiroIx2PQjEXcwYtYl8zXCxb+PAmA2hLIt/6ZEkPHw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*", + "jest-util": "^29.7.0", + "merge-stream": "^2.0.0", + "supports-color": "^8.0.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-worker/node_modules/supports-color": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", + "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/supports-color?sponsor=1" + } + }, + "node_modules/js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "dev": true, + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/jsesc": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-3.0.2.tgz", + "integrity": "sha512-xKqzzWXDttJuOcawBt4KnKHHIf5oQ/Cxax+0PWFG+DFDgHNAdi+TXECADI+RYiFUMmx8792xsMbbgXj4CwnP4g==", + "dev": true, + "license": "MIT", + "bin": { + "jsesc": "bin/jsesc" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/json-buffer": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.1.tgz", + "integrity": "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/json-parse-even-better-errors": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz", + "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==", + "dev": true, + "license": "MIT" + }, + "node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true, + "license": "MIT" + }, + "node_modules/json-stable-stringify-without-jsonify": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz", + "integrity": "sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw==", + "dev": true, + "license": "MIT" + }, + "node_modules/json5": { + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz", + "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==", + "dev": true, + "license": "MIT", + "bin": { + "json5": "lib/cli.js" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/jsonc-parser": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.3.1.tgz", + "integrity": "sha512-HUgH65KyejrUFPvHFPbqOY0rsFip3Bo5wb4ngvdi1EpCYWUQDC5V+Y7mZws+DLkr4M//zQJoanu1SP+87Dv1oQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/keyv": { + "version": "4.5.4", + "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz", + "integrity": "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==", + "dev": true, + "license": "MIT", + "dependencies": { + "json-buffer": "3.0.1" + } + }, + "node_modules/kleur": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", + "integrity": "sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/leven": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/leven/-/leven-3.1.0.tgz", + "integrity": "sha512-qsda+H8jTaUaN/x5vzW2rzc+8Rw4TAQ/4KjB46IwK5VH+IlVeeeje/EoZRpiXvIqjFgK84QffqPztGI3VBLG1A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/levn": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", + "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "prelude-ls": "^1.2.1", + "type-check": "~0.4.0" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/lines-and-columns": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz", + "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==", + "dev": true, + "license": "MIT" + }, + "node_modules/locate-path": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", + "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==", + "dev": true, + "license": "MIT", + "dependencies": { + "p-locate": "^5.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/lodash.memoize": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/lodash.memoize/-/lodash.memoize-4.1.2.tgz", + "integrity": "sha512-t7j+NzmgnQzTAYXcsHYLgimltOV1MXHtlOWf6GjL9Kj8GK5FInw5JotxvbOs+IvV1/Dzo04/fCGfLVs7aXb4Ag==", + "dev": true, + "license": "MIT" + }, + "node_modules/lodash.merge": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", + "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/lru-cache": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", + "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", + "dev": true, + "license": "ISC", + "dependencies": { + "yallist": "^3.0.2" + } + }, + "node_modules/lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true, + "license": "MIT" + }, + "node_modules/make-dir": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-4.0.0.tgz", + "integrity": "sha512-hXdUTZYIVOt1Ex//jAQi+wTZZpUpwBj/0QsOzqegb3rGMMeJiSEu5xLHnYfBrRV4RH2+OCSOO95Is/7x1WJ4bw==", + "dev": true, + "license": "MIT", + "dependencies": { + "semver": "^7.5.3" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/make-error": { + "version": "1.3.6", + "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz", + "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", + "dev": true, + "license": "ISC" + }, + "node_modules/makeerror": { + "version": "1.0.12", + "resolved": "https://registry.npmjs.org/makeerror/-/makeerror-1.0.12.tgz", + "integrity": "sha512-JmqCvUhmt43madlpFzG4BQzG2Z3m6tvQDNKdClZnO3VbIudJYmxsT0FNJMeiB2+JTSlTQTSbU8QdesVmwJcmLg==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "tmpl": "1.0.5" + } + }, + "node_modules/marked": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz", + "integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==", + "dev": true, + "license": "MIT", + "bin": { + "marked": "bin/marked.js" + }, + "engines": { + "node": ">= 12" + } + }, + "node_modules/merge-stream": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", + "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==", + "dev": true, + "license": "MIT" + }, + "node_modules/merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/micromatch": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", + "dev": true, + "license": "MIT", + "dependencies": { + "braces": "^3.0.3", + "picomatch": "^2.3.1" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "license": "MIT", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mimic-fn": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", + "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/minimatch": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", + "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "license": "ISC", + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/minimist": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", + "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/minipass": { + "version": "4.2.8", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-4.2.8.tgz", + "integrity": "sha512-fNzuVyifolSLFL4NzpF+wEF4qrgqaaKX0haXPQEdQ7NKAN+WecoKMHV09YcuL/DHxrUsYQOK3MiuDf7Ip2OXfQ==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=8" + } + }, + "node_modules/moment": { + "version": "2.30.1", + "resolved": "https://registry.npmjs.org/moment/-/moment-2.30.1.tgz", + "integrity": "sha512-uEmtNhbDOrWPFS+hdjFCBfy9f2YoyzRpwcl+DqpC6taX21FzsTLQVbMV/W7PzNSX6x/bhC1zA3c2UQ5NzH6how==", + "license": "MIT", + "engines": { + "node": "*" + } + }, + "node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "license": "MIT" + }, + "node_modules/natural-compare": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", + "integrity": "sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==", + "dev": true, + "license": "MIT" + }, + "node_modules/neo-async": { + "version": "2.6.2", + "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", + "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", + "dev": true, + "license": "MIT" + }, + "node_modules/node-int64": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/node-int64/-/node-int64-0.4.0.tgz", + "integrity": "sha512-O5lz91xSOeoXP6DulyHfllpq+Eg00MWitZIbtPfoSEvqIHdl5gfcY6hYzDWnj0qD5tz52PI08u9qUvSVeUBeHw==", + "dev": true, + "license": "MIT" + }, + "node_modules/node-releases": { + "version": "2.0.18", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.18.tgz", + "integrity": "sha512-d9VeXT4SJ7ZeOqGX6R5EM022wpL+eWPooLI+5UpWn2jCT1aosUQEhQP214x33Wkwx3JQMvIm+tIoVOdodFS40g==", + "dev": true, + "license": "MIT" + }, + "node_modules/normalize-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", + "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/npm-run-path": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", + "integrity": "sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==", + "dev": true, + "license": "MIT", + "dependencies": { + "path-key": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/object-inspect": { + "version": "1.13.3", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.3.tgz", + "integrity": "sha512-kDCGIbxkDSXE3euJZZXzc6to7fCrKHNI/hSRQnRuQ+BWjFNzZwiFF8fj/6o2t2G9/jTj8PSIYTfCLelLZEeRpA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-keys": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", + "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.assign": { + "version": "4.1.5", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.5.tgz", + "integrity": "sha512-byy+U7gp+FVwmyzKPYhW2h5l3crpmGsxl7X2s8y43IgxvG4g3QZ6CffDtsNQy1WsmZpQbO+ybo0AlW7TY6DcBQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.5", + "define-properties": "^1.2.1", + "has-symbols": "^1.0.3", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object.fromentries": { + "version": "2.0.8", + "resolved": "https://registry.npmjs.org/object.fromentries/-/object.fromentries-2.0.8.tgz", + "integrity": "sha512-k6E21FzySsSK5a21KRADBd/NGneRegFO5pLHfdQLpRDETUNJueLXs3WCzyQ3tFRDYgbq3KHGXfTbi2bs8WQ6rQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object.groupby": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/object.groupby/-/object.groupby-1.0.3.tgz", + "integrity": "sha512-+Lhy3TQTuzXI5hevh8sBGqbmurHbbIjAi0Z4S63nthVLmLxfbj4T54a4CfZrXIrt9iP4mVAPYMo/v99taj3wjQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.values": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.2.0.tgz", + "integrity": "sha512-yBYjY9QX2hnRmZHAjG/f13MzmBzxzYgQhFrke06TTyKY5zSTEqkOeukBzIdVA3j3ulu8Qa3MbVFShV7T2RmGtQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/on-exit-leak-free": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/on-exit-leak-free/-/on-exit-leak-free-2.1.2.tgz", + "integrity": "sha512-0eJJY6hXLGf1udHwfNftBqH+g73EU4B504nZeKpz1sYRKafAghwxEJunB2O7rDZkL4PGfsMVnTXZ2EjibbqcsA==", + "license": "MIT", + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", + "dev": true, + "license": "ISC", + "dependencies": { + "wrappy": "1" + } + }, + "node_modules/onetime": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz", + "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==", + "dev": true, + "license": "MIT", + "dependencies": { + "mimic-fn": "^2.1.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/optionator": { + "version": "0.9.4", + "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.4.tgz", + "integrity": "sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g==", + "dev": true, + "license": "MIT", + "dependencies": { + "deep-is": "^0.1.3", + "fast-levenshtein": "^2.0.6", + "levn": "^0.4.1", + "prelude-ls": "^1.2.1", + "type-check": "^0.4.0", + "word-wrap": "^1.2.5" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/p-limit": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", + "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "yocto-queue": "^0.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-locate": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-5.0.0.tgz", + "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==", + "dev": true, + "license": "MIT", + "dependencies": { + "p-limit": "^3.0.2" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/package-json-from-dist": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/package-json-from-dist/-/package-json-from-dist-1.0.1.tgz", + "integrity": "sha512-UEZIS3/by4OC8vL3P2dTXRETpebLI2NiI5vIrjaD/5UtrkFX/tNbwjTSRAGC/+7CAo2pIcBaRgWmcBBHcsaCIw==", + "license": "BlueOak-1.0.0" + }, + "node_modules/parent-module": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", + "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", + "dev": true, + "license": "MIT", + "dependencies": { + "callsites": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/parse-json": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz", + "integrity": "sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.0.0", + "error-ex": "^1.3.1", + "json-parse-even-better-errors": "^2.3.0", + "lines-and-columns": "^1.1.6" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/path-exists": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", + "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/path-is-absolute": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", + "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/path-parse": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", + "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", + "dev": true, + "license": "MIT" + }, + "node_modules/path-scurry": { + "version": "1.11.1", + "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.11.1.tgz", + "integrity": "sha512-Xa4Nw17FS9ApQFJ9umLiJS4orGjm7ZzwUrwamcGQuHSzDyth9boKDaycYdDcZDuqYATXw4HFXgaqWTctW/v1HA==", + "license": "BlueOak-1.0.0", + "dependencies": { + "lru-cache": "^10.2.0", + "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0" + }, + "engines": { + "node": ">=16 || 14 >=14.18" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/path-scurry/node_modules/lru-cache": { + "version": "10.4.3", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.4.3.tgz", + "integrity": "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==", + "license": "ISC" + }, + "node_modules/path-scurry/node_modules/minipass": { + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.1.2.tgz", + "integrity": "sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw==", + "license": "ISC", + "engines": { + "node": ">=16 || 14 >=14.17" + } + }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "dev": true, + "license": "ISC" + }, + "node_modules/picomatch": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", + "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/pino": { + "version": "8.21.0", + "resolved": "https://registry.npmjs.org/pino/-/pino-8.21.0.tgz", + "integrity": "sha512-ip4qdzjkAyDDZklUaZkcRFb2iA118H9SgRh8yzTkSQK8HilsOJF7rSY8HoW5+I0M46AZgX/pxbprf2vvzQCE0Q==", + "license": "MIT", + "dependencies": { + "atomic-sleep": "^1.0.0", + "fast-redact": "^3.1.1", + "on-exit-leak-free": "^2.1.0", + "pino-abstract-transport": "^1.2.0", + "pino-std-serializers": "^6.0.0", + "process-warning": "^3.0.0", + "quick-format-unescaped": "^4.0.3", + "real-require": "^0.2.0", + "safe-stable-stringify": "^2.3.1", + "sonic-boom": "^3.7.0", + "thread-stream": "^2.6.0" + }, + "bin": { + "pino": "bin.js" + } + }, + "node_modules/pino-abstract-transport": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/pino-abstract-transport/-/pino-abstract-transport-1.2.0.tgz", + "integrity": "sha512-Guhh8EZfPCfH+PMXAb6rKOjGQEoy0xlAIn+irODG5kgfYV+BQ0rGYYWTIel3P5mmyXqkYkPmdIkywsn6QKUR1Q==", + "license": "MIT", + "dependencies": { + "readable-stream": "^4.0.0", + "split2": "^4.0.0" + } + }, + "node_modules/pino-std-serializers": { + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/pino-std-serializers/-/pino-std-serializers-6.2.2.tgz", + "integrity": "sha512-cHjPPsE+vhj/tnhCy/wiMh3M3z3h/j15zHQX+S9GkTBgqJuTuJzYJ4gUyACLhDaJ7kk9ba9iRDmbH2tJU03OiA==", + "license": "MIT" + }, + "node_modules/pirates": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/pirates/-/pirates-4.0.6.tgz", + "integrity": "sha512-saLsH7WeYYPiD25LDuLRRY/i+6HaPYr6G1OUlN39otzkSTxKnubR9RTxS3/Kk50s1g2JTgFwWQDQyplC5/SHZg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 6" + } + }, + "node_modules/pkg-dir": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-4.2.0.tgz", + "integrity": "sha512-HRDzbaKjC+AOWVXxAU/x54COGeIv9eb+6CkDSQoNTt4XyWoIJvuPsXizxu/Fr23EiekbtZwmh1IcIG/l/a10GQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "find-up": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/pkg-dir/node_modules/find-up": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", + "integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==", + "dev": true, + "license": "MIT", + "dependencies": { + "locate-path": "^5.0.0", + "path-exists": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/pkg-dir/node_modules/locate-path": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", + "integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==", + "dev": true, + "license": "MIT", + "dependencies": { + "p-locate": "^4.1.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/pkg-dir/node_modules/p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "license": "MIT", + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/pkg-dir/node_modules/p-locate": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", + "integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==", + "dev": true, + "license": "MIT", + "dependencies": { + "p-limit": "^2.2.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/possible-typed-array-names": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/possible-typed-array-names/-/possible-typed-array-names-1.0.0.tgz", + "integrity": "sha512-d7Uw+eZoloe0EHDIYoe+bQ5WXnGMOpmiZFTuMWCwpjzzkL2nTjcKiAk4hh8TjnGye2TwWOk3UXucZ+3rbmBa8Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/prelude-ls": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", + "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/pretty-format": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.7.0.tgz", + "integrity": "sha512-Pdlw/oPxN+aXdmM9R00JVC9WVFoCLTKJvDVLgmJ+qAffBMxsV85l/Lu7sNx4zSzPyoL2euImuEwHhOXdEgNFZQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/schemas": "^29.6.3", + "ansi-styles": "^5.0.0", + "react-is": "^18.0.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/pretty-format/node_modules/ansi-styles": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-5.2.0.tgz", + "integrity": "sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/process": { + "version": "0.11.10", + "resolved": "https://registry.npmjs.org/process/-/process-0.11.10.tgz", + "integrity": "sha512-cdGef/drWFoydD1JsMzuFf8100nZl+GT+yacc2bEced5f9Rjk4z+WtFUTBu9PhOi9j/jfmBPu0mMEY4wIdAF8A==", + "license": "MIT", + "engines": { + "node": ">= 0.6.0" + } + }, + "node_modules/process-warning": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/process-warning/-/process-warning-3.0.0.tgz", + "integrity": "sha512-mqn0kFRl0EoqhnL0GQ0veqFHyIN1yig9RHh/InzORTUiZHFRAur+aMtRkELNwGs9aNwKS6tg/An4NYBPGwvtzQ==", + "license": "MIT" + }, + "node_modules/prompts": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", + "integrity": "sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "kleur": "^3.0.3", + "sisteransi": "^1.0.5" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/proxy-from-env": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.1.0.tgz", + "integrity": "sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==", + "license": "MIT" + }, + "node_modules/punycode": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", + "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/pure-rand": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/pure-rand/-/pure-rand-6.1.0.tgz", + "integrity": "sha512-bVWawvoZoBYpp6yIoQtQXHZjmz35RSVHnUOTefl8Vcjr8snTPY1wnpSPMWekcFwbxI6gtmT7rSYPFvz71ldiOA==", + "dev": true, + "funding": [ + { + "type": "individual", + "url": "https://github.com/sponsors/dubzzz" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/fast-check" + } + ], + "license": "MIT" + }, + "node_modules/queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/quick-format-unescaped": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/quick-format-unescaped/-/quick-format-unescaped-4.0.4.tgz", + "integrity": "sha512-tYC1Q1hgyRuHgloV/YXs2w15unPVh8qfu/qCTfhTYamaw7fyhumKa2yGpdSo87vY32rIclj+4fWYQXUMs9EHvg==", + "license": "MIT" + }, + "node_modules/react-is": { + "version": "18.3.1", + "resolved": "https://registry.npmjs.org/react-is/-/react-is-18.3.1.tgz", + "integrity": "sha512-/LLMVyas0ljjAtoYiPqYiL8VWXzUUdThrmU5+n20DZv+a+ClRoevUzw5JxU+Ieh5/c87ytoTBV9G1FiKfNJdmg==", + "dev": true, + "license": "MIT" + }, + "node_modules/readable-stream": { + "version": "4.5.2", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-4.5.2.tgz", + "integrity": "sha512-yjavECdqeZ3GLXNgRXgeQEdz9fvDDkNKyHnbHRFtOr7/LcfgBcmct7t/ET+HaCTqfh06OzoAxrkN/IfjJBVe+g==", + "license": "MIT", + "dependencies": { + "abort-controller": "^3.0.0", + "buffer": "^6.0.3", + "events": "^3.3.0", + "process": "^0.11.10", + "string_decoder": "^1.3.0" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + } + }, + "node_modules/real-require": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/real-require/-/real-require-0.2.0.tgz", + "integrity": "sha512-57frrGM/OCTLqLOAh0mhVA9VBMHd+9U7Zb2THMGdBUoZVOtGbJzjxsYGDJ3A9AYYCP4hn6y1TVbaOfzWtm5GFg==", + "license": "MIT", + "engines": { + "node": ">= 12.13.0" + } + }, + "node_modules/regexp.prototype.flags": { + "version": "1.5.3", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.3.tgz", + "integrity": "sha512-vqlC04+RQoFalODCbCumG2xIOvapzVMHwsyIGM/SIE8fRhFFsXeH8/QQ+s0T0kDAhKc4k30s73/0ydkHQz6HlQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-errors": "^1.3.0", + "set-function-name": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/regexpp": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/regexpp/-/regexpp-3.2.0.tgz", + "integrity": "sha512-pq2bWo9mVD43nbts2wGv17XLiNLya+GklZ8kaDLV2Z08gDCsGpnKn9BFMepvWuHCbyVvY7J5o5+BVvoQbmlJLg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + } + }, + "node_modules/require-directory": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", + "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/resolve": { + "version": "1.22.8", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.8.tgz", + "integrity": "sha512-oKWePCxqpd6FlLvGV1VU0x7bkPmmCNolxzjMf4NczoDnQcIWrAF+cPtZn5i6n+RfD2d9i0tzpKnG6Yk168yIyw==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-core-module": "^2.13.0", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + }, + "bin": { + "resolve": "bin/resolve" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/resolve-cwd": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/resolve-cwd/-/resolve-cwd-3.0.0.tgz", + "integrity": "sha512-OrZaX2Mb+rJCpH/6CpSqt9xFVpN++x01XnN2ie9g6P5/3xelLAkXWVADpdz1IHD/KFfEXyE6V0U01OQ3UO2rEg==", + "dev": true, + "license": "MIT", + "dependencies": { + "resolve-from": "^5.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/resolve-cwd/node_modules/resolve-from": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-5.0.0.tgz", + "integrity": "sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/resolve-from": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", + "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/resolve.exports": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/resolve.exports/-/resolve.exports-2.0.2.tgz", + "integrity": "sha512-X2UW6Nw3n/aMgDVy+0rSqgHlv39WZAlZrXCdnbyEiKm17DSqHX4MmQMaST3FbeWR5FTuRcUwYAziZajji0Y7mg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/reusify": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", + "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", + "dev": true, + "license": "MIT", + "engines": { + "iojs": ">=1.0.0", + "node": ">=0.10.0" + } + }, + "node_modules/rimraf": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-4.4.1.tgz", + "integrity": "sha512-Gk8NlF062+T9CqNGn6h4tls3k6T1+/nXdOcSZVikNVtlRdYpA7wRJJMoXmuvOnLW844rPjdQ7JgXCYM6PPC/og==", + "dev": true, + "license": "ISC", + "dependencies": { + "glob": "^9.2.0" + }, + "bin": { + "rimraf": "dist/cjs/src/bin.js" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/rimraf/node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/rimraf/node_modules/glob": { + "version": "9.3.5", + "resolved": "https://registry.npmjs.org/glob/-/glob-9.3.5.tgz", + "integrity": "sha512-e1LleDykUz2Iu+MTYdkSsuWX8lvAjAcs0Xef0lNIu0S2wOAzuTxCJtcd9S3cijlwYF18EsU3rzb8jPVobxDh9Q==", + "dev": true, + "license": "ISC", + "dependencies": { + "fs.realpath": "^1.0.0", + "minimatch": "^8.0.2", + "minipass": "^4.2.4", + "path-scurry": "^1.6.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/rimraf/node_modules/minimatch": { + "version": "8.0.4", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-8.0.4.tgz", + "integrity": "sha512-W0Wvr9HyFXZRGIDgCicunpQ299OKXs9RgZfaukz4qAW/pJhcpUfupc9c+OObPOFueNy8VSrZgEmDtk6Kh4WzDA==", + "dev": true, + "license": "ISC", + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "dependencies": { + "queue-microtask": "^1.2.2" + } + }, + "node_modules/safe-array-concat": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/safe-array-concat/-/safe-array-concat-1.1.2.tgz", + "integrity": "sha512-vj6RsCsWBCf19jIeHEfkRMw8DPiBb+DMXklQ/1SGDHOMlHdPUkZXFQ2YdplS23zESTijAcurb1aSgJA3AgMu1Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "get-intrinsic": "^1.2.4", + "has-symbols": "^1.0.3", + "isarray": "^2.0.5" + }, + "engines": { + "node": ">=0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/safe-buffer": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", + "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/safe-regex-test": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/safe-regex-test/-/safe-regex-test-1.0.3.tgz", + "integrity": "sha512-CdASjNJPvRa7roO6Ra/gLYBTzYzzPyyBXxIMdGW3USQLyjWEls2RgW5UBTXaQVp+OrpeCK3bLem8smtmheoRuw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-regex": "^1.1.4" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/safe-stable-stringify": { + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/safe-stable-stringify/-/safe-stable-stringify-2.5.0.tgz", + "integrity": "sha512-b3rppTKm9T+PsVCBEOUR46GWI7fdOs00VKZ1+9c1EWDaDMvjQc6tUwuFyIprgGgTcWoVHSKrU8H31ZHA2e0RHA==", + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/semver": { + "version": "7.6.3", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz", + "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/set-function-length": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", + "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "gopd": "^1.0.1", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/set-function-name": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/set-function-name/-/set-function-name-2.0.2.tgz", + "integrity": "sha512-7PGFlmtwsEADb0WYyvCMa1t+yke6daIG4Wirafur5kcf+MhUnPms1UeR0CKQdTZD81yESwMHbtn+TR+dMviakQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "functions-have-names": "^1.2.3", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "license": "MIT", + "dependencies": { + "shebang-regex": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/shiki": { + "version": "0.14.7", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.7.tgz", + "integrity": "sha512-dNPAPrxSc87ua2sKJ3H5dQ/6ZaY8RNnaAqK+t0eG7p0Soi2ydiqbGOTaZCqaYvA/uZYfS1LJnemt3Q+mSfcPCg==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-sequence-parser": "^1.1.0", + "jsonc-parser": "^3.2.0", + "vscode-oniguruma": "^1.7.0", + "vscode-textmate": "^8.0.0" + } + }, + "node_modules/side-channel": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.6.tgz", + "integrity": "sha512-fDW/EZ6Q9RiO8eFG8Hj+7u/oW+XrPTIChwCOM2+th2A6OblDtYYIpve9m+KvI9Z4C9qSEXlaGR6bTEYHReuglA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.4", + "object-inspect": "^1.13.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/signal-exit": { + "version": "3.0.7", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", + "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/sisteransi": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz", + "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==", + "dev": true, + "license": "MIT" + }, + "node_modules/slash": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", + "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/sonic-boom": { + "version": "3.8.1", + "resolved": "https://registry.npmjs.org/sonic-boom/-/sonic-boom-3.8.1.tgz", + "integrity": "sha512-y4Z8LCDBuum+PBP3lSV7RHrXscqksve/bi0as7mhwVnBW+/wUqKT/2Kb7um8yqcFy0duYbbPxzt89Zy2nOCaxg==", + "license": "MIT", + "dependencies": { + "atomic-sleep": "^1.0.0" + } + }, + "node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/source-map-support": { + "version": "0.5.13", + "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.13.tgz", + "integrity": "sha512-SHSKFHadjVA5oR4PPqhtAVdcBWwRYVd6g6cAXnIbRiIwc2EhPrTuKUBdSLvlEKyIP3GCf89fltvcZiP9MMFA1w==", + "dev": true, + "license": "MIT", + "dependencies": { + "buffer-from": "^1.0.0", + "source-map": "^0.6.0" + } + }, + "node_modules/split2": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/split2/-/split2-4.2.0.tgz", + "integrity": "sha512-UcjcJOWknrNkF6PLX83qcHM6KHgVKNkV62Y8a5uYDVv9ydGQVwAHMKqHdJje1VTWpljG0WYpCDhrCdAOYH4TWg==", + "license": "ISC", + "engines": { + "node": ">= 10.x" + } + }, + "node_modules/sprintf-js": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", + "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==", + "dev": true, + "license": "BSD-3-Clause" + }, + "node_modules/stack-utils": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/stack-utils/-/stack-utils-2.0.6.tgz", + "integrity": "sha512-XlkWvfIm6RmsWtNJx+uqtKLS8eqFbxUg0ZzLXqY0caEy9l7hruX8IpiDnjsLavoBgqCCR71TqWO8MaXYheJ3RQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "escape-string-regexp": "^2.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/stack-utils/node_modules/escape-string-regexp": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz", + "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/string_decoder": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", + "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", + "license": "MIT", + "dependencies": { + "safe-buffer": "~5.2.0" + } + }, + "node_modules/string-length": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/string-length/-/string-length-4.0.2.tgz", + "integrity": "sha512-+l6rNN5fYHNhZZy41RXsYptCjA2Igmq4EG7kZAYFQI1E1VTXarr6ZPXBg6eq7Y6eK4FEhY6AJlyuFIb/v/S0VQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "char-regex": "^1.0.2", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/string-width-cjs": { + "name": "string-width", + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/string.prototype.trim": { + "version": "1.2.9", + "resolved": "https://registry.npmjs.org/string.prototype.trim/-/string.prototype.trim-1.2.9.tgz", + "integrity": "sha512-klHuCNxiMZ8MlsOihJhJEBJAiMVqU3Z2nEXWfWnIqjN0gEFS9J9+IxKozWWtQGcgoa1WUZzLjKPTr4ZHNFTFxw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.0", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/string.prototype.trimend": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.8.tgz", + "integrity": "sha512-p73uL5VCHCO2BZZ6krwwQE3kCzM7NKmis8S//xEC6fQonchbum4eP6kR4DLEjQFO3Wnj3Fuo8NM0kOSjVdHjZQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/string.prototype.trimstart": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.8.tgz", + "integrity": "sha512-UXSH262CSZY1tfu3G3Secr6uGLCFVPMhIqHjlgCUtCCcgihYc/xKs9djMTMUOb2j1mVSeU8EU6NWc/iQKU6Gfg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-ansi-cjs": { + "name": "strip-ansi", + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-bom": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-4.0.0.tgz", + "integrity": "sha512-3xurFv5tEgii33Zi8Jtp55wEIILR9eh34FAW00PZf+JnSsTmV/ioewSgQl97JHvgjoRGwPShsWm+IdrxB35d0w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-final-newline": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz", + "integrity": "sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/supports-preserve-symlinks-flag": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", + "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/test-exclude": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz", + "integrity": "sha512-cAGWPIyOHU6zlmg88jwm7VRyXnMN7iV68OGAbYDk/Mh/xC/pzVPlQtY6ngoIH/5/tciuhGfvESU8GrHrcxD56w==", + "dev": true, + "license": "ISC", + "dependencies": { + "@istanbuljs/schema": "^0.1.2", + "glob": "^7.1.4", + "minimatch": "^3.0.4" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/test-exclude/node_modules/glob": { + "version": "7.2.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", + "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", + "deprecated": "Glob versions prior to v9 are no longer supported", + "dev": true, + "license": "ISC", + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.1.1", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/text-table": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz", + "integrity": "sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw==", + "dev": true, + "license": "MIT" + }, + "node_modules/thread-stream": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/thread-stream/-/thread-stream-2.7.0.tgz", + "integrity": "sha512-qQiRWsU/wvNolI6tbbCKd9iKaTnCXsTwVxhhKM6nctPdujTyztjlbUkUTUymidWcMnZ5pWR0ej4a0tjsW021vw==", + "license": "MIT", + "dependencies": { + "real-require": "^0.2.0" + } + }, + "node_modules/tmpl": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/tmpl/-/tmpl-1.0.5.tgz", + "integrity": "sha512-3f0uOEAQwIqGuWW2MVzYg8fV/QNnc/IpuJNG837rLuczAaLVHslWHZQj4IGiEl5Hs3kkbhwL9Ab7Hrsmuj+Smw==", + "dev": true, + "license": "BSD-3-Clause" + }, + "node_modules/to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-number": "^7.0.0" + }, + "engines": { + "node": ">=8.0" + } + }, + "node_modules/ts-api-utils": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-1.4.0.tgz", + "integrity": "sha512-032cPxaEKwM+GT3vA5JXNzIaizx388rhsSW79vGRNGXfRRAdEAn2mvk36PvK5HnOchyWZ7afLEXqYCvPCrzuzQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=16" + }, + "peerDependencies": { + "typescript": ">=4.2.0" + } + }, + "node_modules/ts-jest": { + "version": "29.2.5", + "resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-29.2.5.tgz", + "integrity": "sha512-KD8zB2aAZrcKIdGk4OwpJggeLcH1FgrICqDSROWqlnJXGCXK4Mn6FcdK2B6670Xr73lHMG1kHw8R87A0ecZ+vA==", + "dev": true, + "license": "MIT", + "dependencies": { + "bs-logger": "^0.2.6", + "ejs": "^3.1.10", + "fast-json-stable-stringify": "^2.1.0", + "jest-util": "^29.0.0", + "json5": "^2.2.3", + "lodash.memoize": "^4.1.2", + "make-error": "^1.3.6", + "semver": "^7.6.3", + "yargs-parser": "^21.1.1" + }, + "bin": { + "ts-jest": "cli.js" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || ^18.0.0 || >=20.0.0" + }, + "peerDependencies": { + "@babel/core": ">=7.0.0-beta.0 <8", + "@jest/transform": "^29.0.0", + "@jest/types": "^29.0.0", + "babel-jest": "^29.0.0", + "jest": "^29.0.0", + "typescript": ">=4.3 <6" + }, + "peerDependenciesMeta": { + "@babel/core": { + "optional": true + }, + "@jest/transform": { + "optional": true + }, + "@jest/types": { + "optional": true + }, + "babel-jest": { + "optional": true + }, + "esbuild": { + "optional": true + } + } + }, + "node_modules/tsconfig-paths": { + "version": "3.15.0", + "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.15.0.tgz", + "integrity": "sha512-2Ac2RgzDe/cn48GvOe3M+o82pEFewD3UPbyoUHHdKasHwJKjds4fLXWf/Ux5kATBKN20oaFGu+jbElp1pos0mg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/json5": "^0.0.29", + "json5": "^1.0.2", + "minimist": "^1.2.6", + "strip-bom": "^3.0.0" + } + }, + "node_modules/tsconfig-paths/node_modules/json5": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.2.tgz", + "integrity": "sha512-g1MWMLBiz8FKi1e4w0UyVL3w+iJceWAFBAaBnnGKOpNa5f8TLktkbre1+s6oICydWAm+HRUGTmI+//xv2hvXYA==", + "dev": true, + "license": "MIT", + "dependencies": { + "minimist": "^1.2.0" + }, + "bin": { + "json5": "lib/cli.js" + } + }, + "node_modules/tsconfig-paths/node_modules/strip-bom": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-3.0.0.tgz", + "integrity": "sha512-vavAMRXOgBVNF6nyEEmL3DBK19iRpDcoIwW+swQ+CbGiu7lju6t+JklA1MHweoWtadgt4ISVUsXLyDq34ddcwA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/type-check": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", + "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", + "dev": true, + "license": "MIT", + "dependencies": { + "prelude-ls": "^1.2.1" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/type-detect": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/type-detect/-/type-detect-4.0.8.tgz", + "integrity": "sha512-0fr/mIH1dlO+x7TlcMy+bIDqKPsw/70tVyeHW787goQjhmqaZe10uwLujubK9q9Lg6Fiho1KUKDYz0Z7k7g5/g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/type-fest": { + "version": "0.20.2", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", + "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", + "dev": true, + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/typed-array-buffer": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/typed-array-buffer/-/typed-array-buffer-1.0.2.tgz", + "integrity": "sha512-gEymJYKZtKXzzBzM4jqa9w6Q1Jjm7x2d+sh19AdsD4wqnMPDYyvwpsIc2Q/835kHuo3BEQ7CjelGhfTsoBb2MQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "is-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/typed-array-byte-length": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/typed-array-byte-length/-/typed-array-byte-length-1.0.1.tgz", + "integrity": "sha512-3iMJ9q0ao7WE9tWcaYKIptkNBuOIcZCCT0d4MRvuuH88fEoEH62IuQe0OtraD3ebQEoTRk8XCBoknUNc1Y67pw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/typed-array-byte-offset": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/typed-array-byte-offset/-/typed-array-byte-offset-1.0.2.tgz", + "integrity": "sha512-Ous0vodHa56FviZucS2E63zkgtgrACj7omjwd/8lTEMEPFFyjfixMZ1ZXenpgCFBBt4EC1J2XsyVS2gkG0eTFA==", + "dev": true, + "license": "MIT", + "dependencies": { + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/typed-array-length": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/typed-array-length/-/typed-array-length-1.0.6.tgz", + "integrity": "sha512-/OxDN6OtAk5KBpGb28T+HZc2M+ADtvRxXrKKbUwtsLgdoxgX13hyy7ek6bFRl5+aBs2yZzB0c4CnQfAtVypW/g==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13", + "possible-typed-array-names": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/typedoc": { + "version": "0.25.13", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.25.13.tgz", + "integrity": "sha512-pQqiwiJ+Z4pigfOnnysObszLiU3mVLWAExSPf+Mu06G/qsc3wzbuM56SZQvONhHLncLUhYzOVkjFFpFfL5AzhQ==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "lunr": "^2.3.9", + "marked": "^4.3.0", + "minimatch": "^9.0.3", + "shiki": "^0.14.7" + }, + "bin": { + "typedoc": "bin/typedoc" + }, + "engines": { + "node": ">= 16" + }, + "peerDependencies": { + "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x" + } + }, + "node_modules/typedoc-plugin-markdown": { + "version": "3.17.1", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.17.1.tgz", + "integrity": "sha512-QzdU3fj0Kzw2XSdoL15ExLASt2WPqD7FbLeaqwT70+XjKyTshBnUlQA5nNREO1C2P8Uen0CDjsBLMsCQ+zd0lw==", + "dev": true, + "license": "MIT", + "dependencies": { + "handlebars": "^4.7.7" + }, + "peerDependencies": { + "typedoc": ">=0.24.0" + } + }, + "node_modules/typedoc/node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/typedoc/node_modules/minimatch": { + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", + "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", + "dev": true, + "license": "ISC", + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/typescript": { + "version": "5.4.5", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.5.tgz", + "integrity": "sha512-vcI4UpRgg81oIRUFwR0WSIHKt11nJ7SAVlYNIu+QpqeyXP+gpQJy/Z4+F0aGxSE4MqwjyXvW/TzgkLAx2AGHwQ==", + "dev": true, + "license": "Apache-2.0", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/uglify-js": { + "version": "3.19.3", + "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.19.3.tgz", + "integrity": "sha512-v3Xu+yuwBXisp6QYTcH4UbH+xYJXqnq2m/LtQVWKWzYc1iehYnLixoQDN9FH6/j9/oybfd6W9Ghwkl8+UMKTKQ==", + "dev": true, + "license": "BSD-2-Clause", + "optional": true, + "bin": { + "uglifyjs": "bin/uglifyjs" + }, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/unbox-primitive": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.2.tgz", + "integrity": "sha512-61pPlCD9h51VoreyJ0BReideM3MDKMKnh6+V9L08331ipq6Q8OFXZYiqP6n/tbHx4s5I9uRhcye6BrbkizkBDw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "has-bigints": "^1.0.2", + "has-symbols": "^1.0.3", + "which-boxed-primitive": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/undici-types": { + "version": "6.19.8", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.19.8.tgz", + "integrity": "sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw==", + "dev": true, + "license": "MIT" + }, + "node_modules/update-browserslist-db": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.1.1.tgz", + "integrity": "sha512-R8UzCaa9Az+38REPiJ1tXlImTJXlVfgHZsglwBD/k6nj76ctsH1E3q4doGrukiLQd3sGQYu56r5+lo5r94l29A==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "escalade": "^3.2.0", + "picocolors": "^1.1.0" + }, + "bin": { + "update-browserslist-db": "cli.js" + }, + "peerDependencies": { + "browserslist": ">= 4.21.0" + } + }, + "node_modules/uri-js": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", + "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "punycode": "^2.1.0" + } + }, + "node_modules/v8-to-istanbul": { + "version": "9.3.0", + "resolved": "https://registry.npmjs.org/v8-to-istanbul/-/v8-to-istanbul-9.3.0.tgz", + "integrity": "sha512-kiGUalWN+rgBJ/1OHZsBtU4rXZOfj/7rKQxULKlIzwzQSvMJUUNgPwJEEh7gU6xEVxC0ahoOBvN2YI8GH6FNgA==", + "dev": true, + "license": "ISC", + "dependencies": { + "@jridgewell/trace-mapping": "^0.3.12", + "@types/istanbul-lib-coverage": "^2.0.1", + "convert-source-map": "^2.0.0" + }, + "engines": { + "node": ">=10.12.0" + } + }, + "node_modules/vscode-oniguruma": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/vscode-oniguruma/-/vscode-oniguruma-1.7.0.tgz", + "integrity": "sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==", + "dev": true, + "license": "MIT" + }, + "node_modules/vscode-textmate": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-8.0.0.tgz", + "integrity": "sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==", + "dev": true, + "license": "MIT" + }, + "node_modules/walker": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/walker/-/walker-1.0.8.tgz", + "integrity": "sha512-ts/8E8l5b7kY0vlWLewOkDXMmPdLcVV4GmOQLyxuSswIJsweeFZtAsMF7k1Nszz+TYBQrlYRmzOnr398y1JemQ==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "makeerror": "1.0.12" + } + }, + "node_modules/which": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "license": "ISC", + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "node-which": "bin/node-which" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/which-boxed-primitive": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.0.2.tgz", + "integrity": "sha512-bwZdv0AKLpplFY2KZRX6TvyuN7ojjr7lwkg6ml0roIy9YeuSr7JS372qlNW18UQYzgYK9ziGcerWqZOmEn9VNg==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-bigint": "^1.0.1", + "is-boolean-object": "^1.1.0", + "is-number-object": "^1.0.4", + "is-string": "^1.0.5", + "is-symbol": "^1.0.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/which-typed-array": { + "version": "1.1.15", + "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.15.tgz", + "integrity": "sha512-oV0jmFtUky6CXfkqehVvBP/LSWJ2sy4vWMioiENyJLePrBO/yKyV9OyJySfAKosh+RYkIl5zJCNZ8/4JncrpdA==", + "dev": true, + "license": "MIT", + "dependencies": { + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/word-wrap": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.5.tgz", + "integrity": "sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/wordwrap": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", + "integrity": "sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/wrap-ansi": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", + "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/wrap-ansi-cjs": { + "name": "wrap-ansi", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", + "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/write-file-atomic": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-4.0.2.tgz", + "integrity": "sha512-7KxauUdBmSdWnmpaGFg+ppNjKF8uNLry8LyzjauQDOVONfFLNKrKvQOxZ/VuTIcS/gge/YNahf5RIIQWTSarlg==", + "dev": true, + "license": "ISC", + "dependencies": { + "imurmurhash": "^0.1.4", + "signal-exit": "^3.0.7" + }, + "engines": { + "node": "^12.13.0 || ^14.15.0 || >=16.0.0" + } + }, + "node_modules/y18n": { + "version": "5.0.8", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", + "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=10" + } + }, + "node_modules/yallist": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", + "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", + "dev": true, + "license": "ISC" + }, + "node_modules/yargs": { + "version": "17.7.2", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz", + "integrity": "sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==", + "dev": true, + "license": "MIT", + "dependencies": { + "cliui": "^8.0.1", + "escalade": "^3.1.1", + "get-caller-file": "^2.0.5", + "require-directory": "^2.1.1", + "string-width": "^4.2.3", + "y18n": "^5.0.5", + "yargs-parser": "^21.1.1" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/yargs-parser": { + "version": "21.1.1", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", + "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=12" + } + }, + "node_modules/yocto-queue": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", + "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..b127f49 --- /dev/null +++ b/package.json @@ -0,0 +1,49 @@ +{ + "dependencies": { + "@eslint/config-array": "^0.19.0", + "axios": "^1.7.7", + "fs": "^0.0.1-security", + "glob": "^10.0.0", + "https": "^1.0.0", + "moment": "^2.30.1", + "pino": "^8.21.0" + }, + "name": "@siemens/simatic-s7-webserver-api", + "version": "1.0.0", + "main": "dist/index.js", + "types": "dist/index.d.ts", + "author": "Siemens", + "description": "Library for wrapping the Simatic S7-1500 Webserver API ", + "devDependencies": { + "@types/jest": "^29.5.12", + "@types/moment": "^2.11.29", + "@types/node": "^20.16.5", + "@types/pino": "^7.0.4", + "@typescript-eslint/eslint-plugin": "^8.0.0", + "@typescript-eslint/parser": "^8.0.0", + "eslint": "^8.0.0", + "eslint-config-semistandard": "^17.0.0", + "eslint-config-standard": "^17.1.0", + "eslint-plugin-import": "^2.29.1", + "eslint-plugin-n": "^15.7.0", + "eslint-plugin-promise": "^6.1.1", + "jest": "^29.7.0", + "rimraf": "^4.0.0", + "ts-jest": "^29.2.4", + "typedoc": "^0.25.12", + "typedoc-plugin-markdown": "^3.17.1", + "typescript": "^5.3.3" + }, + "license": "MIT", + "scripts": { + "clean": "rimraf dist", + "build": "npm run clean && tsc", + "prepublishOnly": "npm run build", + "lint": "eslint \"src/**/*.ts\"", + "test": "jest" + }, + "files": [ + "/dist" + ] + +} diff --git a/src/alarms.ts b/src/alarms.ts new file mode 100644 index 0000000..e813372 --- /dev/null +++ b/src/alarms.ts @@ -0,0 +1,169 @@ +import * as request from './request'; +import { JsonrpcBaseResponse } from './response'; +import pino from 'pino'; + +export class Filters { + mode: string = ''; + attributes: string[] = []; +} +export class Acknowledgement { + state: string = ''; + timestamp: string = ''; + +} +export class EntryAlarm { + id: string = ''; + alarm_number: number = 0; + status: string = ''; + timestamp: string = ''; + producer: string = ''; + hwid?: number; + acknowledgement?: Acknowledgement; + alarm_text: string = ''; + info_text: string = ''; + text_inconsistent ?: boolean; +} +export class Alarms { + language ?: string; + last_modified: string = ''; + count_current: number = 0; + count_max: number = 0; + entries?: EntryAlarm[]; +} +export class AlarmsBrowse extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, language: string, count?: number, alarm_id?: string, filters ?: Filters) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'Alarms.Browse'; + this.params = { language }; + + // Different way to check if the properties are defined, if is present, it will add it at the end of the object. + if (count !== undefined) { + this.params.count = count; + } + if (alarm_id !== undefined) { + this.params.alarm_id = alarm_id; + } + if (filters !== undefined) { + this.params.filters = { mode: filters.mode, attributes: filters.attributes }; + } + } + + public parse (response: JsonrpcBaseResponse): AlarmsBrowseResponse | null { + const logger = pino(); + + if (response.is_error() || !response.result) { + logger.error('Response has error or response result does not exist'); + return null; + } + if (response.result.entries.length <= 0) { + logger.error('There are no entries'); + + } + let container: Alarms = new Alarms(); + const responseR = new AlarmsBrowseResponse(); + const responseProcess = new AlarmsBrowseResponse(); + let Var : Alarms | null = null; + + responseProcess.result = response.result; + + if (responseProcess.result !== undefined) { + + Var = new Alarms(); + for (const [key, value] of Object.entries(responseProcess.result) as [string, any][]) { + if (typeof key === 'string') { + + // IF for each one like, if not you will overwerite properties: + if (key === 'language') { + Var.language = value || undefined; + } + if (key === 'last_modified') { + Var.last_modified = value || ''; + } + if (key === 'count_current') { + Var.count_current = Number(value) || 0; + } + if (key === 'count_max') { + Var.count_max = Number(value) || 0; + } + + if (key === 'entries') { + Var.entries = []; + for (const content of value) { + + if (Array.isArray(value)) { + + const entry = new EntryAlarm(); + + entry.id = content.id || ''; + entry.alarm_number = Number(content.alarm_number) || 0; + entry.status = content.status || ''; + entry.timestamp = content.timestamp || ''; + entry.producer = content.producer || ''; + entry.hwid = Number(content.hwid) || undefined; + + if ('acknowledgement' in content) { + entry.acknowledgement = new Acknowledgement(); + + entry.acknowledgement.state = content.acknowledgement.state || ''; + entry.acknowledgement.timestamp = content.acknowledgement.timestamp || ''; + } + + entry.alarm_text = content.alarm_text || ''; + entry.info_text = content.info_text || ''; + entry.text_inconsistent = Boolean(content.text_incosistent) || undefined; + + Var.entries?.push(entry); + } + } + } + } + } + if (Var !== null) { + container = Var; + } + } + responseR.error = response.error; + responseR.id = response.id; + responseR.result = container; + return responseR; + } +} + +export class AlarmsBrowseResponse extends JsonrpcBaseResponse { + result?: Alarms; + constructor () { + super('AlarmsBrowse'); + } +} + +export class AlarmsAcknowledge extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, id: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'Alarms.Acknowledge'; + this.params = { id }; + } + + public parse (response: JsonrpcBaseResponse):AlarmsAcknowledgeResponse | null { + const responseR = new AlarmsAcknowledgeResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } + +} + +export class AlarmsAcknowledgeResponse extends JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('AlarmsAcknowledge'); + } +} diff --git a/src/api.ts b/src/api.ts new file mode 100644 index 0000000..9652381 --- /dev/null +++ b/src/api.ts @@ -0,0 +1,547 @@ +import * as response from './response'; +import * as request from './request'; +import pino from 'pino'; + +export enum ApiTicketState { + CREATED = 'created', + ACTIVE = 'active', + COMPLETED = 'completed', + FAILED = 'failed' +} + +export class ApiLogin extends request.JsonrpcBaseRequest { + + constructor (config: request.RequestConfig, user: string = 'Anonymous', password: string = '', include_web_application_cookie?: boolean) { + const method = 'Api.Login'; + const params = { user, password, include_web_application_cookie }; + + super(config.address, config.protocol, config.verifyTls, method, params); + } + + public parse (response: response.JsonrpcBaseResponse): ApiLoginResponse | null { + const responseR = new ApiLoginResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result && response.result.token !== undefined) { + + responseR.result = response.result.token; // Store directly the string instead of {token: 'string with the token'} + return responseR; + } + return null; + } + +} +export class ApiLoginResponse extends response.JsonrpcBaseResponse { + result?: string; + constructor () { + super('ApiLogin'); + } +} +export class ApiPing extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig) { + const method = 'Api.Ping'; + + super(config.address, config.protocol, config.verifyTls, method); + } + + public parse (response: response.JsonrpcBaseResponse): ApiPingResponse| null { + const responseR = new ApiPingResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class ApiPingResponse extends response.JsonrpcBaseResponse { + result?: string; + constructor () { + super('ApiPing'); + } +} + +export class ApiBrowse extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig) { + const method = 'Api.Browse'; + super(config.address, config.protocol, config.verifyTls, method); + } + + public parse (response: response.JsonrpcBaseResponse): ApiBrowseResponse|null { + const container: string[] = []; + const responseR = new ApiBrowseResponse(); + const responseProcess = new ApiBrowseResponse(); + + responseProcess.result = response.result; + if (response.is_error() || response.result === null) { + return null; + } + + if (response.result?.length === 0) { + return null; + } + if (responseProcess.result !== undefined) { + for (const value of Object.values(responseProcess.result)) { + if (typeof value === 'object' && 'name' in value) { + container.push((value as { name: string }).name); + } + } + } + responseR.error = response.error; + responseR.id = response.id; + responseR.result = container; + return responseR; + } +} +export class ApiBrowseResponse extends response.JsonrpcBaseResponse { + result?: string[]; + constructor () { + super('ApiBrowse'); + } +} + +export class ApiGetPermissions extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig) { + const method = 'Api.GetPermissions'; + + super(config.address, config.protocol, config.verifyTls, method); + } + + public parse (response: response.JsonrpcBaseResponse) { + const container: string[] = []; + const responseR = new ApiGetPermissionsResponse(); + const responseProcess = new ApiGetPermissionsResponse(); + + responseProcess.result = response.result; + if (response.is_error() || response.result === null) { + return null; + } + + if (response.result?.length === 0) { + return null; + } + if (responseProcess.result !== undefined) { + for (const value of Object.values(responseProcess.result)) { + if (typeof value === 'object' && 'name' in value) { + container.push((value as { name: string }).name); + } + } + } + responseR.result = container; + responseR.error = response.error; + responseR.id = response.id; + return responseR; + } +} +export class ApiGetPermissionsResponse extends response.JsonrpcBaseResponse { + result?: string[]; + constructor () { + super('ApiGetPermissions'); + } +} + +export class ApiLogout extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string) { + const method = 'Api.Logout'; + + super(config.address, config.protocol, config.verifyTls, method, undefined, token); + } + + public parse (response: response.JsonrpcBaseResponse): ApiLogoutResponse| null { + const responseR = new ApiLogoutResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class ApiLogoutResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('ApiLogout'); + } +} + +export class ApiGetCertificateUrl extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig) { + const method = 'Api.GetCertificateUrl'; + + super(config.address, config.protocol, config.verifyTls, method); + } + + public parse (response: response.JsonrpcBaseResponse): ApiGetCertificateUrlResponse| null { + const responseR = new ApiGetCertificateUrlResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result || response.result === '') { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class ApiGetCertificateUrlResponse extends response.JsonrpcBaseResponse { + result?: string; + constructor () { + super('ApiGetCertificateUrl'); + } +} +export class ApiVersion extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig) { + const method = 'Api.Version'; + + super(config.address, config.protocol, config.verifyTls, method); + } + + public parse (response: response.JsonrpcBaseResponse): ApiVersionResponse| null { + const responseR = new ApiVersionResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } + +} + +export class ApiVersionResponse extends response.JsonrpcBaseResponse { + result?: number; + constructor () { + super('ApiVersion'); + } +} +export class ApiCloseTickets extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, id: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + this.method = 'Api.CloseTicket'; + this.params = { id }; + } + + public parse (response: response.JsonrpcBaseResponse): ApiCloseTicketsResponse| null { + const responseR = new ApiCloseTicketsResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} + +export class ApiCloseTicketsResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('ApiCloseTickets'); + } +} + +export class ApiTicket { + id: string = ''; + date_created: string = ''; + provider: string = ''; + state: ApiTicketState = ApiTicketState.FAILED; + data?: object; + +} +export class CustomTicket { + max_tickets: number = 0; + ticket: ApiTicket[] = []; +} +export class ApiBrowseTickets extends request.JsonrpcBaseRequest { + constructor (config:request.RequestConfig, token: string, id?: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + this.method = 'Api.BrowseTickets'; + if (id) { + this.params = { id }; + } + } + + public parse (response: response.JsonrpcBaseResponse): ApiBrowseTicketsResponse | null { + const logger = pino(); + if (response.is_error() || !response.result) { + logger.error('Response has error or response result does not exist'); + return null; + } + + if ((response.result.tickets).length <= 0) { + logger.info('Tickets array is empty'); + + } + + let container: CustomTicket = new CustomTicket(); + const responseR = new ApiBrowseTicketsResponse(); + const responseProcess = new ApiBrowseTicketsResponse(); + let Var : CustomTicket | null = null; + responseProcess.result = response.result; + + if (responseProcess.result !== undefined) { + + for (const [key, value] of Object.entries(responseProcess.result) as [string, unknown][]) { + + if (typeof key === 'string' && key === 'max_tickets') { + Var = new CustomTicket(); + Var.max_tickets = Number(value) || 0; + // I only create the instance when I find max_tickets because it only appears once! + // Necessary to check if in key there is an string. + } else if (key === 'tickets' && Var !== null) { + if (Array.isArray(value)) { + for (const content of value) { + const ticket = new ApiTicket(); + ticket.id = content.id || ''; + ticket.date_created = content.date_created || ''; + ticket.provider = content.provider || ''; + ticket.state = content.state || ApiTicketState.FAILED; + ticket.data = content.data; + Var.ticket.push(ticket); + + } + } + } + + } + if (Var !== null) { + container = Var; + } + } + responseR.error = response.error; + responseR.id = response.id; + responseR.result = container; + return responseR; + } +} + +export class ApiBrowseTicketsResponse extends response.JsonrpcBaseResponse { + result?: CustomTicket; + constructor () { + super('ApiBrowseTickets'); + } +} + +export class QuantityStructure { + webapi_max_http_request_body_size: number = 0; + webapi_max_parallel_requests: number = 0; + webapi_max_parallel_user_sessions: number = 0; + +} +export class ApiGetQuantityStructures extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string) { + const method = 'Api.GetQuantityStructures'; + + super(config.address, config.protocol, config.verifyTls, method, undefined, token); + + } + + public parse (response: response.JsonrpcBaseResponse): ApiGetQuantityStructuresResponse | null { + const logger = pino(); + + if (response.is_error() || !response.result) { + logger.error('Response has error or response result does not exist'); + return null; + } + if (response.result.length <= 0) { + logger.error('There are no quantity structures'); + return null; + } + + const responseR = new ApiGetQuantityStructuresResponse(); + const responseProcess = new ApiGetQuantityStructuresResponse(); + let vars: QuantityStructure | null = null; + + responseProcess.result = response.result; + + if (responseProcess.result !== undefined) { + const Var = new QuantityStructure(); + for (const [key, value] of Object.entries(response.result) as unknown as [string, any]) { + + if (key === 'webapi_max_http_request_body_size') { + Var.webapi_max_http_request_body_size = Number(value) || 0; + } + if (key === 'webapi_max_parallel_requests') { + Var.webapi_max_parallel_requests = Number(value) || 0; + } + if (key === 'webapi_max_parallel_user_sessions') { + Var.webapi_max_parallel_user_sessions = Number(value) || 0; + } + vars = Var; + } + } + responseR.error = response.error; + responseR.id = response.id; + if (vars !== null) { + responseR.result = vars; + } + + return responseR; + } +} +export class ApiGetQuantityStructuresResponse extends response.JsonrpcBaseResponse { + result?: QuantityStructure; + constructor () { + super('ApiGetQuantityStructures'); + } +} + +export class ApiChangePassword extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, username: string, password: string, new_password: string) { + const method = 'Api.ChangePassword'; + const params = { username, password, new_password }; + + super(config.address, config.protocol, config.verifyTls, method, params, token); + } + + public parse (response: response.JsonrpcBaseResponse): ApiChangePasswordResponse | null { + const responseR = new ApiChangePasswordResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class ApiChangePasswordResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('ApiChangePassword'); + } +} +export class PasswordPolicy { + min_password_length: number = 0; + max_password_length: number = 0; + min_digits: number = 0; + min_special_characters: number = 0; + requires_uppercase_characters: boolean = false; + requires_lowercase_characters: boolean = false; +} +export class ApiGetPasswordPolicy extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig) { + const method = 'Api.GetPasswordPolicy'; + + super(config.address, config.protocol, config.verifyTls, method); + } + + public parse (response: response.JsonrpcBaseResponse): ApiGetPasswordPolicyResponse | null { + const logger = pino(); + + if (response.is_error() || !response.result) { + logger.error('Response has error or response result does not exist'); + return null; + } + if (response.result.length <= 0) { + logger.error('There is not password policy'); + return null; + } + + let container: PasswordPolicy | null = null; + const responseR = new ApiGetPasswordPolicyResponse(); + const responseProcess = new ApiGetPasswordPolicyResponse(); + responseProcess.result = response.result; + if (responseProcess.result !== undefined) { + for (const [key, value] of Object.entries(response.result) as [string, any]) { + if (key === 'password_policy') { + const values = new PasswordPolicy(); + + values.min_password_length = 'min_password_length' in value ? Number(value.min_password_length) : 0; + values.max_password_length = 'max_password_length' in value ? Number(value.max_password_length) : 0; + values.min_digits = 'min_digits' in value ? Number(value.min_digits) : 0; + values.min_special_characters = 'min_special_characters' in value ? Number(value.min_special_characters) : 0; + values.requires_uppercase_characters = 'requires_uppercase_characters' in value ? Boolean(value.requires_uppercase_characters) : false; + values.requires_lowercase_characters = 'requires_lowercase_characters' in value ? Boolean(value.requires_lowercase_characters) : false; + + container = values; + } + + } + } + responseR.error = response.error; + responseR.id = response.id; + if (container !== null) { + responseR.result = container; + } + return responseR; + + } +} + +export class ApiGetPasswordPolicyResponse extends response.JsonrpcBaseResponse { + result?: PasswordPolicy; + constructor () { + super('ApiGetPasswordPolicy'); + } +} +export class ApiGetAuthenticationMode extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig) { + const method = 'Api.GetAuthenticationMode'; + + super(config.address, config.protocol, config.verifyTls, method); + } + + public parse (response:response.JsonrpcBaseResponse): ApiGetAuthenticationModeResponse | null { + const logger = pino(); + + if (response.is_error() || !response.result) { + logger.error('Response has error or response result does not exist'); + return null; + } + if (response.result.length <= 0) { + logger.error('There are not authentication modes'); + return null; + } + + const container: string[] = []; + const responseR = new ApiGetAuthenticationModeResponse(); + const responseProcess = new ApiGetAuthenticationModeResponse(); + responseProcess.result = response.result; + + if (responseProcess.result !== undefined) { + for (const [key, value] of Object.entries(response.result) as unknown as [string, string[]]) { // First is mandatory to put unknown to do that typescript believe on what you expect on the response type + if (key === 'authentication_modes') { + container.push(value); + } + } + } + + responseR.error = response.error; + responseR.id = response.id; + if (container !== null) { + responseR.result = container; + } + return responseR; + } +} + +export class ApiGetAuthenticationModeResponse extends response.JsonrpcBaseResponse { + result?: string[]; + constructor () { + super('ApiGetAuthenticationMode'); + } +} diff --git a/src/datalogs.ts b/src/datalogs.ts new file mode 100644 index 0000000..fab6ba5 --- /dev/null +++ b/src/datalogs.ts @@ -0,0 +1,34 @@ +import * as response from './response'; +import * as request from './request'; + +export class DataLogsDownloadAndClear extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, resource: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'DataLogs.DownloadAndClear'; + this.params = { resource }; + } + + public parse (response: response.JsonrpcBaseResponse): DataLogsDownloadAndClearResponse | null { + const responseR = new DataLogsDownloadAndClearResponse(); + responseR.error = response.error; + responseR.id = response.id; + + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result && typeof response.result === 'string') { + + responseR.result = response.result; + return responseR; + } + return null; + } +} + +export class DataLogsDownloadAndClearResponse extends response.JsonrpcBaseResponse { + result?: string; + constructor () { + super('DataLogsDownloadAndClear'); + } +} diff --git a/src/diagnosticbuffer.ts b/src/diagnosticbuffer.ts new file mode 100644 index 0000000..949ea39 --- /dev/null +++ b/src/diagnosticbuffer.ts @@ -0,0 +1,122 @@ +import * as request from './request'; +import * as response from './response'; +import pino from 'pino'; + +export class Filters { + mode: string = ''; + attributes: string[] = []; +} +export class Event { + textlist_id: number = 0; + text_id: number = 0; + +} +export class Entry { + timestamp: string = ''; + status: string = ''; + long_text: string = ''; + short_text: string = ''; + help_text: string = ''; + event: Event = new Event(); +} + +export class DiagnosticBufferStructure { + last_modified: string = ''; + count_current: number = 0; + count_max: number = 0; + language?: string; + entries?: Entry[]; +} +export class DiagnosticBufferBrowse extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, language: string, count?: number, filters?: Filters) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'DiagnosticBuffer.Browse'; + this.params = { language }; + + // Different way to check if the properties are defined, if is present, it will add it at the end of the object. + if (count !== undefined) { + this.params.count = count; + } + if (filters !== undefined) { + this.params.filters = { mode: filters.mode, attributes: filters.attributes }; + } + } + + public parse (response: response.JsonrpcBaseResponse): DiagnosticBufferBrowseResponse | null { + const logger = pino(); + + if (response.is_error() || !response.result) { + logger.error('Response has error or response result does not exist'); + return null; + } + if (!response.result.entries) { + logger.info('There are no entries'); + + } + let container: DiagnosticBufferStructure = new DiagnosticBufferStructure(); + const responseR = new DiagnosticBufferBrowseResponse(); + const responseProcess = new DiagnosticBufferBrowseResponse(); + let Var : DiagnosticBufferStructure | null = null; + + responseProcess.result = response.result; + + if (responseProcess.result !== undefined) { + Var = new DiagnosticBufferStructure(); + for (const [key, value] of Object.entries(responseProcess.result) as [string, any][]) { + if (typeof key === 'string') { + + if (key === 'last_modified') { + Var.last_modified = value || ''; + } + if (key === 'count_current') { + Var.count_current = Number(value) || 0; + } + if (key === 'count_max') { + Var.count_max = Number(value) || 0; + } + if (key === 'language') { + Var.language = value || undefined; + } + + if (key === 'entries') { + Var.entries = []; + for (const content of value) { + const entry = new Entry(); + + entry.timestamp = content.timestamp || ''; + entry.status = content.status || ''; + entry.long_text = content.long_text || ''; + entry.short_text = content.short_text || ''; + entry.help_text = content.help_text || ''; + + if ('event' in content) { + entry.event = new Event(); + entry.event.textlist_id = Number(content.event.textlist_id) || 0; + entry.event.text_id = Number(content.event.text_id) || 0; + + } + Var.entries?.push(entry); + } + + } + } + + } + if (Var !== null) { + container = Var; + } + } + responseR.error = response.error; + responseR.id = response.id; + responseR.result = container; + return responseR; + } +} + +export class DiagnosticBufferBrowseResponse extends response.JsonrpcBaseResponse { + result?: DiagnosticBufferStructure; + constructor () { + super('DiagnosticBufferBrowse'); + } +} diff --git a/src/failsafe.ts b/src/failsafe.ts new file mode 100644 index 0000000..ebc2605 --- /dev/null +++ b/src/failsafe.ts @@ -0,0 +1,163 @@ +import * as request from './request'; +import * as response from './response'; +import pino from 'pino'; + +export class FailsafeReadRuntimeGroupsStructure { + name: string = ''; + signature: string = ''; + cycle_time_current: string = ''; + cycle_time_max: string = ''; + runtime_current: string = ''; + runtime_max: string = ''; +} +export class FailsafeReadRuntimeGroups extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + this.method = 'Failsafe.ReadRuntimeGroups'; + } + + public parse (response: response.JsonrpcBaseResponse): FailsafeReadRuntimeGroupsResponse| null { + const logger = pino({ + // transport: { + // target: 'pino-pretty', + // options: {} + // } + }); + + if (response.is_error() || !response.result) { + logger.error('Response has error or response result does not exist'); + return null; + } + if (response.result.groups.length <= 0) { + logger.error('There are no F-runtime groups'); + return null; + } + + const container: FailsafeReadRuntimeGroupsStructure[] = []; + const responseR = new FailsafeReadRuntimeGroupsResponse(); + const responseProcess = new FailsafeReadRuntimeGroupsResponse(); + let Var : FailsafeReadRuntimeGroupsStructure | null = null; + + responseProcess.result = response.result; + + if (responseProcess.result !== undefined && 'groups' in responseProcess.result) { + const groups = responseProcess.result.groups as FailsafeReadRuntimeGroupsStructure[]; + + for (const group of groups) { + Var = new FailsafeReadRuntimeGroupsStructure(); + Var.name = group.name; + Var.signature = group.signature; + Var.cycle_time_current = group.cycle_time_current; + Var.cycle_time_max = group.cycle_time_max; + Var.runtime_current = group.runtime_current; + Var.runtime_max = group.runtime_max; + + container.push(Var); + } + } + responseR.error = response.error; + responseR.id = response.id; + responseR.result = container; + return responseR; + } +} + +export class FailsafeReadRuntimeGroupsResponse extends response.JsonrpcBaseResponse { + result?: FailsafeReadRuntimeGroupsStructure[]; + constructor () { + super('FailsafeReadRuntimeGroups'); + } +} +export class CPUResponse { + last_f_program_modification: string = ''; + collective_signature: string = ''; + remaining_time?: string; +} + +export class ModuleResponse { + f_monitoring_time: number = 0; + f_source_address: number = 0; + f_destination_address: number = 0; + f_par_crc: number[] = []; +} +export class FailsafeReadParametersStructure { + safety_mode?: string; + type: string = ''; + parameters?: CPUResponse | ModuleResponse; +} +export class FailsafeReadParameters extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, hwid: number) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'Failsafe.ReadParameters'; + this.params = { hwid }; + } + + public parse (response: response.JsonrpcBaseResponse): FailsafeReadParametersResponse | null { + const logger = pino(); + + if (response.is_error() || !response.result) { + logger.error('Response has error or response result does not exist'); + return null; + } + + let container: FailsafeReadParametersStructure = new FailsafeReadParametersStructure(); + const responseR = new FailsafeReadParametersResponse(); + const responseProcess = new FailsafeReadParametersResponse(); + let Var : FailsafeReadParametersStructure | null = null; + + responseProcess.result = response.result; + + if (responseProcess.result !== undefined) { + for (const [key, value] of Object.entries(responseProcess.result) as [string, any][]) { + + if (typeof key === 'string') { + if (key === 'type') { + Var = new FailsafeReadParametersStructure(); + Var.type = value || ''; + } + if (key === 'safety_mode' && Var !== null) { + Var.safety_mode = value || undefined; + } + + if (key === 'parameters' && Var !== null) { + + if (Var.type === 'f_cpu') { // HWID FOR CPU IS THE LOCAL ONE + Var.parameters = new CPUResponse(); + + Var.parameters.last_f_program_modification = value.last_f_program_modification || ''; + Var.parameters.collective_signature = value.collective_signature || ''; + Var.parameters.remaining_time = value.remaining_time || undefined; + + } + if (Var.type === 'f_module') { + Var.parameters = new ModuleResponse(); + + Var.parameters.f_monitoring_time = Number(value.f_monitoring_time) || 0; + Var.parameters.f_source_address = Number(value.f_source_address) || 0; + Var.parameters.f_destination_address = Number(value.f_destination_address) || 0; + Var.parameters.f_par_crc = Array(value.f_par_crc) || []; + + } + } + } + } + if (Var !== null) { + container = Var; + } + + } + responseR.error = response.error; + responseR.id = response.id; + responseR.result = container; + return responseR; + } +} + +export class FailsafeReadParametersResponse extends response.JsonrpcBaseResponse { + result?: FailsafeReadParametersStructure; + constructor () { + super('FailsafeReadParameters'); + } +} + diff --git a/src/files.ts b/src/files.ts new file mode 100644 index 0000000..3e72176 --- /dev/null +++ b/src/files.ts @@ -0,0 +1,258 @@ +import * as request from './request'; +import * as response from './response'; +import pino from 'pino'; + +export class FilesDownload extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, resource: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'Files.Download'; + this.params = { resource }; + } + + public parse (response: response.JsonrpcBaseResponse): FilesDownloadResponse| null { + const responseR = new FilesDownloadResponse(); + responseR.error = response.error; + responseR.id = response.id; + + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result && typeof response.result === 'string') { + + responseR.result = response.result; // Store directly the string instead of {token: 'string with the token'} + return responseR; + } + return null; + } + +} +export class FilesDownloadResponse extends response.JsonrpcBaseResponse { + result?: string; + constructor () { + super('FilesDownload'); + } +} + +export class FilesCreate extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, resource: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'Files.Create'; + this.params = { resource }; + } + + public parse (response: response.JsonrpcBaseResponse): FilesCreateResponse | null { + const responseR = new FilesCreateResponse(); + responseR.error = response.error; + responseR.id = response.id; + + if (response.is_error() === true && response.result === null) { + return null; + } + if (response.result && typeof response.result === 'string') { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class FilesCreateResponse extends response.JsonrpcBaseResponse { + result?: string; + constructor () { + super('FilesCreate'); + } +} +export class FilesDelete extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, resource: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'Files.Delete'; + this.params = { resource }; + } + + public parse (response: response.JsonrpcBaseResponse): FilesDeleteResponse | null { + const responseR = new FilesDeleteResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class FilesDeleteResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('FilesDelete'); + } +} +export class FilesCreateDirectory extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, resource:string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'Files.CreateDirectory'; + this.params = { resource }; + } + + public parse (response: response.JsonrpcBaseResponse): FilesCreateDirectoryResponse | null { + const responseR = new FilesCreateDirectoryResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class FilesCreateDirectoryResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('FilesCreateDirectory'); + } +} + +export class FilesDeleteDirectory extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, resource:string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'Files.DeleteDirectory'; + this.params = { resource }; + } + + public parse (response: response.JsonrpcBaseResponse): FilesDeleteDirectoryResponse | null { + const responseR = new FilesDeleteDirectoryResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class FilesDeleteDirectoryResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('FilesDeleteDirectory'); + } +} + +export class FilesRename extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, resource:string, new_resource: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'Files.Rename'; + this.params = { resource, new_resource }; + } + + public parse (response: response.JsonrpcBaseResponse): FilesRenameResponse | null { + const responseR = new FilesRenameResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} + +export class FilesRenameResponse extends response.JsonrpcBaseResponse { + result?: boolean; + + constructor () { + super('FilesRename'); + } +} + +export class Resources { + name: string = ''; + type: string = ''; + size?: number; + last_modified: string = ''; + state?: string; + +} + +export class FilesBrowse extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, resource?:string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'Files.Browse'; + if (resource) { + this.params = { resource }; + } + } + + public parse (response: response.JsonrpcBaseResponse): FilesBrowseResponse|null { + const logger = pino(); + + if (response.is_error() || !response.result) { + logger.error('Response has error or response result does not exist'); + return null; + } + if (response.result.resources.length <= 0) { + logger.error('There are no files'); + return null; + } + + const container : Resources[] = []; + const responseR = new FilesBrowseResponse(); + const responseProcess = new FilesBrowseResponse(); + let vars : Resources | null = null; + responseProcess.result = response.result; + if (responseProcess.result !== undefined) { + + for (const [key, value] of Object.entries(response.result) as [string, unknown][]) { + + if (typeof key === 'string' && key === 'resources') { + // Don't create vars here because in the loop it will override the same instance + if (Array.isArray(value)) { + for (const content of value) { + vars = new Resources(); + vars.name = content.name || ''; + vars.type = content.type || ''; + vars.size = Number(content.size) || undefined; + vars.last_modified = content.last_modified || ''; + vars.state = content.state || undefined; + + if (vars !== null) { + container.push(vars); + } + + } + } + + } + } + + } + + responseR.error = response.error; + responseR.id = response.id; + responseR.result = container; + return responseR; + + } +} +export class FilesBrowseResponse extends response.JsonrpcBaseResponse { + result?: Resources[]; + constructor () { + super('FilesBrowse'); + } +} diff --git a/src/index.ts b/src/index.ts new file mode 100644 index 0000000..df9307c --- /dev/null +++ b/src/index.ts @@ -0,0 +1,15 @@ +export * from './alarms'; +export * from './api'; +export * from './datalogs'; +export { Event, Entry, DiagnosticBufferStructure, DiagnosticBufferBrowse, DiagnosticBufferBrowseResponse } from './diagnosticbuffer'; +export * from './failsafe'; +export * from './files'; +export * from './plc'; +export * from './plcprogram'; +export * from './project'; +export * from './request'; +export * from './response'; +export * from './syslog'; +export * from './ticket'; +export * from './webApp'; +export * from './webserver'; diff --git a/src/plc.ts b/src/plc.ts new file mode 100644 index 0000000..2d424af --- /dev/null +++ b/src/plc.ts @@ -0,0 +1,391 @@ + +import * as request from './request'; +import * as response from './response'; +import * as pino from 'pino'; + +export enum PlcOpertingMode { + STOP = 'stop', + STARTUP = 'startup', + RUN = 'run', + HOLD = 'hold', + UNKNOWN = '' +} + +export function obtainEnumValue> ( + enumObj: T, + value: keyof T +): T[keyof T] | undefined { + + // Is done in this way to extend that response.result is a record and not directly a string, so the keyof T is an STRING, and the return is from T[string] or undefined. + + const stringValue = value.toString(); // Necessary to convert first in a String to be able to use UpperCase function. + const upperCaseValue = stringValue.toUpperCase()as unknown as keyof T; + + return enumObj[upperCaseValue] as T[keyof T] | undefined; + +} +export class PlcReadOperatingMode extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string) { + const method = 'Plc.ReadOperatingMode'; + + super(config.address, config.protocol, config.verifyTls, method, undefined, token); + } + + public parse (response: response.JsonrpcBaseResponse): PlcReadOperatingModeResponse | null { + const responseR = new PlcReadOperatingModeResponse(); + + responseR.id = response.id; + responseR.error = response.error; + + if (response.is_error() || response.result === null) { + return null; + } + if (response.result?.length === 0) { + return null; + } + if (response.result !== undefined) { + + responseR.result = obtainEnumValue(PlcOpertingMode, response.result as unknown as keyof typeof PlcOpertingMode); // necessary unknown first to convert the result in the keyof the typeof PlcOperatingMode + obtainEnumValue(PlcOpertingMode, response.result); + } + return responseR; + } +} +export class PlcReadOperatingModeResponse extends response.JsonrpcBaseResponse { + result?: string; + constructor () { + super('PlcReadOperatingMode'); + } +} + +export class PlcRequestChangeOperatingMode extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, mode: PlcOpertingMode) { + const method = 'Plc.RequestChangeOperatingMode'; + let modefunc; + if (mode === PlcOpertingMode.STARTUP || mode === PlcOpertingMode.HOLD) { + throw new Error('Mode for mode change my only be Start or Stop'); + } else { + modefunc = { mode: mode.valueOf() }; + } + + super(config.address, config.protocol, config.verifyTls, method, modefunc, token); + + } + + public parse (response: response.JsonrpcBaseResponse): PlcRequestChangeOperatingModeResponse | null { + const responseR = new PlcRequestChangeOperatingModeResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class PlcRequestChangeOperatingModeResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('PlcRequestChangeOperatingMode'); + } +} +export class PlcReadSystemTime extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig) { + const method = 'Plc.ReadSystemTime'; + + super(config.address, config.protocol, config.verifyTls, method); + } + + public parse (response: response.JsonrpcBaseResponse): PlcReadSystemTimeResponse | null { + const responseR = new PlcReadSystemTimeResponse(); + responseR.id = response.id; + responseR.error = response.error; + if (response.is_error() || !response.result || !('timestamp' in response.result)) { + return null; + } + + const timestampStr: string = response.result.timestamp; + const [datePart, msPart] = timestampStr.split('.'); + const timestamp: Date = new Date(datePart); + const ms: number = 1 / parseFloat(msPart.replace('Z', '')) * 1000; // This is because at the end of the ms there is a z + + responseR.result = new Date(timestamp.getTime() + ms); + return responseR; // No change between timeStamp and timeStamp + ms + + } +} + +export class PlcReadSystemTimeResponse extends response.JsonrpcBaseResponse { + result?: Date; + constructor () { + super('PlcReadSystemTime'); + } +} + +export class PlcSetSystemTime extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, timestamp: string) { + + super(config.address, config.protocol, config.verifyTls); + this.token = token; + this.method = 'Plc.SetSystemTime'; + this.params = { timestamp }; + } + + public parse (response: response.JsonrpcBaseResponse): PlcSetSystemTimeResponse | null { + const responseR = new PlcSetSystemTimeResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } + +} + +export class PlcSetSystemTimeResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('PlcSetSystemTime'); + } +} + +export class RuleStart { + month: number = 0; + week: number = 0; + day_of_week: string = ''; + hour: number = 0; + minute: number = 0; +} +export class RuleStd { + start: RuleStart = new RuleStart(); +} + +export class RuleDst { + start: RuleStart = new RuleStart(); + offset: string = ''; +} +export class Rule { + ruleStd: RuleStd = new RuleStd(); + ruleDst: RuleDst = new RuleDst(); +} +export class TimeSettings { + current_offset: string = ''; + utc_offset: string = ''; + rule?: Rule; +} + +export class PlcReadTimeSettings extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig) { + super(config.address, config.protocol, config.verifyTls); + this.method = 'Plc.ReadTimeSettings'; + } + + public parse (response: response.JsonrpcBaseResponse): PlcReadTimeSettingsResponse | null { + const logger = pino.pino(); + + if (response.is_error() || !response.result) { + logger.error('Response has error or response result does not exist'); + return null; + } + if (response.result.length <= 0) { + logger.error('There are no time settings'); + return null; + } + const container: TimeSettings[] = []; + const responseR = new PlcReadTimeSettingsResponse(); + const responseProcess = new PlcReadTimeSettingsResponse(); + let Var : TimeSettings | null = null; + responseProcess.result = response.result; + + if (responseProcess.result !== undefined) { + if (Var == null) { + Var = new TimeSettings(); + } + for (const [key, value] of Object.entries(responseProcess.result) as [string, any]) { + if (Var !== null) { + if (key === 'current_offset') { + Var.current_offset = value || ''; + } + if (key === 'utc_offset') { + Var.utc_offset = value || ''; + } + if (key === 'rule') { + Var.rule = new Rule(); + if ('dst' in value) { // value is an object not an string, not possible to do value == 'dst' + Var.rule.ruleDst = new RuleDst(); + Var.rule.ruleDst.offset = value.dst.offset || ''; + if ('start' in value.dst) { // same case, start is an object inside dst + Var.rule.ruleDst.start = new RuleStart(); + Var.rule.ruleDst.start.month = Number(value.dst.start.month) || 0; + Var.rule.ruleDst.start.week = Number(value.dst.start.week) || 0; + Var.rule.ruleDst.start.day_of_week = value.dst.start.day_of_week || ''; + Var.rule.ruleDst.start.hour = Number(value.dst.start.hour) || 0; + Var.rule.ruleDst.start.minute = Number(value.dst.start.minute) || 0; + } + } + if ('std' in value) { + Var.rule.ruleStd = new RuleStd(); + if ('start' in value.std) { + Var.rule.ruleStd.start = new RuleStart(); + Var.rule.ruleStd.start.month = Number(value.std.start.month) || 0; + Var.rule.ruleStd.start.week = Number(value.std.start.week) || 0; + Var.rule.ruleStd.start.day_of_week = value.std.start.day_of_week || ''; + Var.rule.ruleStd.start.hour = Number(value.std.start.hour) || 0; + Var.rule.ruleStd.start.minute = Number(value.std.start.minute) || 0; + } + } + } + container.push(Var); + } + + } + + } + responseR.error = response.error; + responseR.id = response.id; + responseR.result = container; + return responseR; + } +} +export class PlcReadTimeSettingsResponse extends response.JsonrpcBaseResponse { + result?: TimeSettings[]; + constructor () { + super('PlcReadTimeSettings'); + } +} +export class PlcSetTimeSettings extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, TimeSettings: TimeSettings) { + + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'Plc.SetTimeSettings'; + this.params = {}; + if (!(TimeSettings.rule)) { + this.params = { utc_offset: TimeSettings.utc_offset }; // There is no Setting for current_offset + + } else { + if (!this.params.rule) { + this.params.rule = {}; + } + + if (!this.params.rule.dst) { + this.params.rule.dst = {}; + } + + if (!this.params.rule.dst.start) { + this.params.rule.dst.start = {}; + } + if (!this.params.rule.std) { + this.params.rule.std = {}; + } + + if (!this.params.rule.std.start) { + this.params.rule.std.start = {}; + } // Must initialice empty objects before writing the properties. + this.params.utc_offset = TimeSettings.utc_offset; + this.params.rule.dst = { + offset: TimeSettings.rule.ruleDst.offset, + start: { + month: TimeSettings.rule.ruleDst.start.month, + week: TimeSettings.rule.ruleDst.start.week, + day_of_week: TimeSettings.rule.ruleDst.start.day_of_week, + hour: TimeSettings.rule.ruleDst.start.hour, + minute: TimeSettings.rule.ruleDst.start.minute + } + }; + this.params.rule.std.start = { + month: TimeSettings.rule.ruleStd.start.month, + week: TimeSettings.rule.ruleStd.start.week, + day_of_week: TimeSettings.rule.ruleStd.start.day_of_week, + hour: TimeSettings.rule.ruleStd.start.hour, + minute: TimeSettings.rule.ruleStd.start.minute + }; + } + + } + + public parse (response: response.JsonrpcBaseResponse): PlcSetTimeSettingsResponse | null { + const responseR = new PlcSetTimeSettingsResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class PlcSetTimeSettingsResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('PlcSetTimeSettings'); + } +} +export class PlcCreateBackup extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string) { + + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + this.method = 'Plc.CreateBackup'; + } + + public parse (response: response.JsonrpcBaseResponse): PlcCreateBackupResponse | null { + const responseR = new PlcCreateBackupResponse(); + responseR.error = response.error; + responseR.id = response.id; + + if (response.is_error() === true && response.result === null) { + return null; + } + if (response.result && typeof response.result === 'string') { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class PlcCreateBackupResponse extends response.JsonrpcBaseResponse { + result?: string; + constructor () { + super('PlcCreateBackup'); + } +} +export class PlcRestoreBackup extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, password: string) { + + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + this.method = 'Plc.RestoreBackup'; + this.params = { password }; + } + + public parse (response: response.JsonrpcBaseResponse): PlcRestoreBackupResponse | null { + const responseR = new PlcCreateBackupResponse(); + responseR.error = response.error; + responseR.id = response.id; + + if (response.is_error() === true && response.result === null) { + return null; + } + if (response.result && typeof response.result === 'string') { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class PlcRestoreBackupResponse extends response.JsonrpcBaseResponse { + result?: string; + constructor () { + super('PlcRestoreBackup'); + } +} diff --git a/src/plcprogram.ts b/src/plcprogram.ts new file mode 100644 index 0000000..ffbf420 --- /dev/null +++ b/src/plcprogram.ts @@ -0,0 +1,190 @@ +import * as response from './response'; +import * as request from './request'; + +export class PlcProgramBrowseArrayData { + start_index : number = 0; + count: number = 0; + +} + +export class PlcProgramBrowseVariable { + name : string = ''; + address ?: string; + read_only ?: boolean; + has_children ?: boolean; + db_number ?: number; + area ?: string; + datatype : string = ''; + max_length ?: number; + array_dimensions ?: PlcProgramBrowseArrayData; + block_number ?: number; + block_type ?: string; + +} + +export class PlcProgramBrowse extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, mode: string, Var?: string, type?: string[]) { + const method = 'PlcProgram.Browse'; + let params = {}; + if (Var !== undefined) { + params = { var: Var, mode }; + } else { + if (type !== undefined) { + params = { mode, type }; + } + params = { mode }; + } + + // reading the examples that if there is Var there is no type. + + super(config.address, config.protocol, config.verifyTls, method, params, token); + + } + + public parse (response: response.JsonrpcBaseResponse): PlcProgramBrowseResponse|null { + if (response.is_error() || response.result === null) { + return null; + } + if (response.result?.length === 0) { + return null; + } + + const container : PlcProgramBrowseVariable[] = []; + const responseR = new PlcProgramBrowseResponse(); + const responseProcess = new PlcProgramBrowseResponse(); + let Vars: PlcProgramBrowseVariable | null = null; + + responseProcess.result = response.result; + if (responseProcess.result !== undefined) { + + for (const value of Object.values(response.result)as [string, any]) { // Only returns a Record, not an array of arrays + + Vars = new PlcProgramBrowseVariable(); + if (Vars !== null) { + Vars.name = value.name || ''; + Vars.address = value.address || undefined; + Vars.read_only = Boolean(value.read_only) || undefined; + Vars.has_children = Boolean(value.db_number) || undefined; + Vars.area = value.area || undefined; + Vars.datatype = value.datatype || ''; + Vars.max_length = Number(value.max_length) || undefined; + + if (value === 'array_dimensions') { + Vars.array_dimensions = new PlcProgramBrowseArrayData(); + Vars.array_dimensions.start_index = Number(value.array_dimensions.start_index) || 0; + Vars.array_dimensions.count = Number(value.array_dimensions.count) || 0; + + } + Vars.block_number = Number(value.block_number) || 0; + Vars.block_type = value.block_type || undefined; + container.push(Vars); + } + } + + } + responseR.error = response.error; + responseR.id = response.id; + responseR.result = container; + return responseR; + } +} +export class PlcProgramBrowseResponse extends response.JsonrpcBaseResponse { + result?: PlcProgramBrowseVariable[]; + constructor () { + super('PlcProgramBrowse'); + } + +} +export class PlcProgramDownloadProfilingData extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string) { + const method = 'PlcProgram.DownloadProfilingData'; + + super(config.address, config.protocol, config.verifyTls, method, undefined, token); + } + + public parse (response: response.JsonrpcBaseResponse): PlcProgramDownloadProfilingDataResponse | null { + const responseR = new PlcProgramDownloadProfilingDataResponse(); + responseR.error = response.error; + responseR.id = response.id; + + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result && typeof response.result === 'string') { + + responseR.result = response.result; // Store directly the string instead of {token: 'string with the token'} + return responseR; + } + return null; + } + /* File name + The file name for downloading the runtime data to a web browser is structured as follows: + [project_name]_[module_name]_YYYY-MM-DD_HH-mm-ss_profiling.bin + Example: [1500_example01]_[plc_1]_2023-11-03_12-20-05_profiling.bin + The file name is returned as an HTTP Content-Disposition header in the server response. */ +} + +export class PlcProgramDownloadProfilingDataResponse extends response.JsonrpcBaseResponse { + result?: string; + constructor () { + super('PlcProgramDownloadProfilingData'); + } +} +export class PlcProgramRead extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, Var: string, mode: string = 'simple') { + const method = 'PlcProgram.Read'; + const params = { var: Var, mode }; + super(config.address, config.protocol, config.verifyTls, method, params, token); + } + + public parse (response: response.JsonrpcBaseResponse): PlcProgramReadResponse | null { + const responseR = new PlcProgramReadResponse(); + responseR.error = response.error; + responseR.id = response.id; + + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response) { // Don't check response.result because if it is a false boolean it returns false + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class PlcProgramReadResponse extends response.JsonrpcBaseResponse { + result?: any; // any because it depends on the data type of the tag, it can be an array, a string, an int... + constructor () { + super('PlcProgramRead'); + } +} + +export class PlcProgramWrite extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, Var: string, value: unknown, mode: string = 'simple') { + const method = 'PlcProgram.Write'; + const params = { var: Var, value, mode }; + + super(config.address, config.protocol, config.verifyTls, method, params, token); + } + + public parse (response: response.JsonrpcBaseResponse): PlcProgramWriteResponse | null { + const responseR = new PlcProgramWriteResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class PlcProgramWriteResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('PlcProgramWrite'); + } +} + diff --git a/src/project.ts b/src/project.ts new file mode 100644 index 0000000..8552fc9 --- /dev/null +++ b/src/project.ts @@ -0,0 +1,57 @@ +import * as response from './response'; +import * as request from './request'; +import * as pino from 'pino'; + +export class Languages { + language: string = ''; +} +export class ProjectLanguages extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string) { + const method = 'Project.ReadLanguages'; + super(config.address, config.protocol, config.verifyTls, method, undefined, token); + } + + public parse (response: response.JsonrpcBaseResponse): ProjectLanguagesResponse | null { + const logger = pino.pino(); + + if (response.is_error() || !response.result) { + logger.error('Response has error or response result does not exist'); + return null; + } + if (response.result.languages <= 0) { + logger.error('There are no languages configured in this project'); + return null; + } + + const responseProcess = new ProjectLanguagesResponse(); + const responseR = new ProjectLanguagesResponse(); + const container : Languages[] = []; + let Vars: Languages | null = null; + responseProcess.result = response.result; + console.log(response.result); + if (responseProcess.result !== undefined) { + for (const [key, value] of Object.entries(response.result)) { + if (key === 'languages' && Array.isArray(value)) { + Vars = new Languages(); + for (const content of value) { + if (typeof content === 'object' && content !== null && 'language' in content) { + + Vars.language = content.language || ''; + container.push(Vars); + } + } + } + } + } + responseR.error = response.error; + responseR.id = response.id; + responseR.result = container; + return responseR; + } +} +export class ProjectLanguagesResponse extends response.JsonrpcBaseResponse { + result?: Languages[]; + constructor () { + super('ProjectReadLanguages'); + } +} diff --git a/src/request.ts b/src/request.ts new file mode 100644 index 0000000..a374e56 --- /dev/null +++ b/src/request.ts @@ -0,0 +1,283 @@ + +import axios, { AxiosResponse } from 'axios'; + +import moment from 'moment'; +import pino from 'pino'; +import https from 'https'; +import * as response from './response'; + +// const currentDate = moment().format('YYYY-MM-DD HH:mm:ss'); + +export class RequestConfig { + /** + * Base configuration for all requests + + * @attribute address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + * or the DNS name + * Must not contain the protocol definition, this has to be set + * via the protocol attribute + *@attribute protocol: defines the protocol (http/https) for connecting to the PLC + *@attribute verifyTls: Switch wether TLS Server Certificate should be verified against + * trusted certificates or trusted by default + *@attribute plcCertificate: Identifies the certificate from the PLC in the local system to be able to access the PLC. + */ + address = ''; + protocol = ''; + verifyTls = true; + plcCertificate?: Buffer; + + /* constructor(address, protocol, verifyTls){ + this.address = address; + this.protocol = protocol; + this.verifyTls = verifyTls; + } */ + +} + +export class JsonrpcBaseRequest { + /** + * Represents a base type for all jsonrpc requests against + * the SIMATC S7 webserver + * Provides all functions to build the request and execute it. + * + *@attribute method: defines the jsonrpc method and functions that are + * defined for the WebAPI + *@attribute params: defines additional parameters required by the specific request methods + *@attribute address: Address of the PLC webserver, can be either a IPv4/ IPv6 address + * or the DNS name + * Must not contain the protocol definition, this has to be set + * via the protocol attribute + *@attribute protocol: defines the protocol (http/https) for connecting to the PLC + *@attribute token: Token for authentication and authorization on the PLC + *@attribute verifyTls: Switch wether TLS Server Certificate should be verified against + * trusted certificates or trusted by default + *@attribute plcCertificate: File that contains the PLC certificate to be able to access the PLC. + */ + + method ?: string; + params ?: Record; + address : string = ''; + protocol : string = ''; + token ?: string; + verifyTls : boolean = true; + response ?: AxiosResponse; + plcCertificate?: Buffer; + private reqID ?: number; + + constructor (address: string, protocol: string, verifyTls: boolean, method?: string, params?: Record, token?: string, reqID ?: number, response?: AxiosResponse, plcCertificate?: Buffer) { + this.method = method; + this.params = params; + this.address = address; + this.protocol = protocol; + this.token = token; + this.verifyTls = verifyTls; + this.response = response; + this.plcCertificate = plcCertificate; + this.reqID = reqID; + + } + + public headers (): Record { + /** + * Creates an object for the necessary header fields. + */ + if (this.token !== undefined) { + return { + 'Content-type': 'application/json', + 'X-Auth-Token': this.token + }; + } + return { 'Content-type': 'application/json' }; + + } + + public gethttpsAgent (): https.Agent | undefined { + if (this.verifyTls === false) { + return new https.Agent({ rejectUnauthorized: false }); + } else { + // Load the PLC certificate + if (this.plcCertificate) { + console.log('Using PLC Certificate'); + return new https.Agent({ ca: this.plcCertificate }); + } + } + return undefined; + } + + public body ():{ + id: number; + jsonrpc: string; + method ?: string; + params?: Record; + } | null | undefined { + const req_body: { + id: number; + jsonrpc: string; + method?: string; + params?: Record; + } = { + id: Math.floor(Math.random() * 1000), + jsonrpc: '2.0', + method: this.method + }; + /** + * Creates the body object of the request + */ + this.reqID = req_body.id; + if (this.params) { + req_body.params = this.params; + } + + return req_body; + } + + public url () { + /** + * Creates the url based on the information address and protocol + */ + + return `${this.protocol}://${this.address}/api/jsonrpc`; + } + + public __str__ () { + return `--HTTP POST Request to ${this.url()}--- + \tHeaders: ${this.headers()} + \tBody: ${this.body()}`; + } + + public async request (): Promise { + /** + * Executes the POST request against the webserver. + * + * @param {Axios} axiosObject - The Axios object used for making the POST request. + * @returns {Promise} A Promise that resolves to an Axios response. + */ + + this.response = await axios.post(this.url(), this.body(), { headers: this.headers(), httpsAgent: this.gethttpsAgent() }); + + return this.response; + + } + + public async execute (): Promise { + const post_res = await this.request(); + const logger = pino(); + + logger.debug(this.__str__()); + logger.debug(this.format_response()); + + if (post_res == null) { + logger.error('Response was empty, unable to parse'); + + return null; + } + const res = response.JsonrpcBaseResponse.parse(post_res); + + if (res === undefined) { + logger.error('Unable to parse the response, it is not typical jsonrpc format'); + console.log(('Unable to parse the response, it is not typical jsonrpc format')); + return null; + } + if (res?.is_error() === true) { + logger.error(`WebAPI responded with an error: ${res.error?.toString()}`); + console.log(`WebAPI responded with an error: ${res.error?.toString()}`); + return null; + } + if (res) { + return this.parse(res); + } + return null; + + } + + public format_response () { + if (this.response === undefined) { + return undefined; + } + const current_time = moment().format('YYYY-MM-DD HH:mm:ss'); + + return `--HTTP POST Request --- ${current_time} + \tResponse code: ${this.response.status} + \tResponse: ${this.response.data}`; + + } + + public async bulkRequest (requestObject: { url: string, headers: Record, data: unknown[], httpsAgent: unknown }): Promise { + /** + * Builds a single request body with multiple entries by iterating through + * paramsArray, using the existing `body()` method to structure each entry. + */ + + this.response = await axios.post(requestObject.url, requestObject.data, { + // Temporarily set `this.params` to create the correct body structure per item + headers: requestObject.headers, + httpsAgent: requestObject.httpsAgent + }); + + return this.response; + } + + public async bulkExecute (paramsArray: Array>): Promise { + /** + * Builds a single request body with multiple entries by iterating through + * paramsArray, using the existing `body()` method to structure each entry. + */ + const requestObject = { + url: this.url(), + method: 'POST', + headers: this.headers(), + data: paramsArray.map((params) => { + this.params = params; + return this.body(); + }), + httpsAgent: this.gethttpsAgent() + }; + + const post_res = await this.bulkRequest(requestObject) as AxiosResponse; + const logger = pino(); + console.log('POST_RES', post_res); + logger.debug(this.__str__()); + logger.debug(this.format_response()); + + // Check if the response is valid and contains an array + if (!post_res || !Array.isArray(post_res.data)) { + logger.error('Response was empty or not in expected batch format'); + return null; + } + + return this.parseResponses(post_res); + } + + public parse (response: response.JsonrpcBaseResponse): response.JsonrpcBaseResponse | null { + /** + * Parses the response of a simple request and returns the + * result as an object. Only checks if the response has an error or if the result of the response is empty. + * If no result is provided or the request failed None is returned. + * + * @param response The {@link JsonRpcBaseResponse} object + */ + const logger = pino(); + if (response.is_error() === true) { + logger.debug('Response has error'); + return null; + } + if (response.result === undefined) { + logger.debug('Response result structure is null'); + return null; + } + + return response; + } + + public parseResponses (responses: AxiosResponse): response.JsonrpcBaseResponse[] | null { + const parsedResponses = response.JsonrpcBaseResponse.parseBulk(responses); // Directly call the static method, this will do the pertinent comprobations of the complete response + + if (!parsedResponses) { + console.log('Failed to parse the bulk response.'); + return null; + } + + return parsedResponses; + + } +} diff --git a/src/response.ts b/src/response.ts new file mode 100644 index 0000000..f5816d1 --- /dev/null +++ b/src/response.ts @@ -0,0 +1,187 @@ + +import * as Axios from 'axios'; + +export class JsonrpcError { + /** + * Base type for all errors returned by the SIMATIC S7 Webserver + + @param code: Code of the error, defined in webserver documentation + @param message: Optional additional information provided by the Webserver + @param http_code: HTTP Response code provided by the server response + */ + code: number; + message?: string; + http_code: number; + + constructor (http_code: number, code: number = -1, message?: string) { + /** + * Constructor for the error type + + @param http_code: HTTP Response code provided by the server response + @param code: Optional code of the error, defined in webserver documentation + @param message: Optional additional information provided by the Webserver + */ + + this.http_code = http_code; + this.code = code; + this.message = message; + } + + public toString (): string { + /** String formatter for the error type + */ + if (this.message) { + return `HTTP ${this.http_code} - [${this.code}]: ${this.message}`; + } + + return `HTTP ${this.http_code} - [${this.code}]: No message, further information provided in the docs`; + } + +} + +export class JsonrpcBaseResponse { + /** + * Base type for all responsed returned by the SIMATIC S7 Webserver + + @param error: Generic type for error if there is one, else None + @param result: Object that provides result data + */ + readonly kind ?: string; + id: number = 0; + error ?: JsonrpcError; + result ?: any; // object + + // Create result: Record, + // Create a switch and check type of result + + constructor (kind ?: string, id ?: number, error?: JsonrpcError, result?: Record) { + this.kind = kind; + this.id = id !== undefined ? id : 0; + this.error = error; + this.result = result; + } + + public is_error (): boolean { + if (this.error != null) { + return true; + } + return false; + } + + static parse (response: Axios.AxiosResponse): JsonrpcBaseResponse | null { + /** + * Tries to parse a generic HTTP response into the specific jsonrpc + * response format. Returns None if parsing is not successfull + + @param response: Generic HTTP response + */ + + const res = new JsonrpcBaseResponse(); + res.id = response.data.id; + if (Number(response.status) !== 200) { + res.error = new JsonrpcError(response.status, -1); + return res; + } + + const json_response = response.data; + + if (typeof json_response === 'string') { + // Try to convert the string in a Json Object + const jsonStringCleaned = json_response.replace(/\n/g, ''); // clean the string from changes of line + const resultObject = JSON.parse(jsonStringCleaned); + + // Verify if the result objects is not null and its a valid object + if (resultObject !== null && typeof resultObject === 'object') { + + res.result = resultObject.result; + return res; + } else { + console.log('The result of the conversion is not a valid JSON object.'); + + } + } else if (json_response.result !== undefined) { + + res.result = json_response.result; + return res; + } + if (json_response.error !== undefined) { + let msg = null; + let code = -1; + if (json_response.error.message !== undefined) { + msg = json_response.error.message; + } + if (json_response.error.code !== undefined) { + code = json_response.error.code; + } + + res.error = new JsonrpcError(response.status, code, msg); + return res; + } + + return null; + } + + static parseBulk (response: Axios.AxiosResponse): JsonrpcBaseResponse[] | null { + + /** + * Parses a bulk HTTP response containing multiple JSON-RPC responses. + * Checks the main response status and then iterates over each entry in response.data. + * + * @param response - The full HTTP response from Axios + * @returns Array of parsed JsonrpcBaseResponse or null if parsing fails + */ + const parsedResponses: JsonrpcBaseResponse[] = []; + // Check if the main HTTP response status is valid + if (Number(response.status) !== 200) { + const errorResponse = new JsonrpcBaseResponse(); + errorResponse.error = new JsonrpcError(response.status, -1); + + parsedResponses.push(errorResponse); + return parsedResponses; + } + // Check if response.data is an array as expected for bulk responses + if (!Array.isArray(response.data)) { + console.error('Invalid data format: Expected an array in response.data'); + return null; + } + + // Process each item in response.data array + for (const respData of response.data) { + const res = new JsonrpcBaseResponse(); + res.id = respData.id; + + // Check for errors in each individual JSON-RPC response + if (respData.error !== undefined) { + let msg = null; + let code = -1; + if (respData.error.message !== undefined) { + msg = respData.error.message; + } + if (respData.error.code !== undefined) { + code = respData.error.code; + } + res.error = new JsonrpcError(response.status, code, msg); + } else if (respData.result !== undefined) { + // Valid result in individual response + res.result = respData.result; + } else { + // Log any unexpected format + console.log('Invalid response entry', respData); + continue; // Skip adding to parsedResponses + } + + // Add the parsed response to the results array + parsedResponses.push(res); + } + + return parsedResponses.length > 0 ? parsedResponses : null; + } + + public __str__ (): string { + if (this.is_error() === true) { + return `Error response: ${this.error?.toString()}`; + } + return `Good response: ${this.result}`; + } + +} diff --git a/src/syslog.ts b/src/syslog.ts new file mode 100644 index 0000000..d6747c0 --- /dev/null +++ b/src/syslog.ts @@ -0,0 +1,84 @@ +import * as pino from 'pino'; +import * as request from './request'; +import * as response from './response'; + +export class SyslogData { + raw: string = ''; +} +export class SyslogBrowseStructure { + entries: SyslogData[] = []; + count_total: number = 0; + count_lost: number = 0; +} +export class SyslogBrowse extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, redundancy_id?: number, count?: number, first?: number) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + this.method = 'Syslog.Browse'; + this.params = {}; + if (redundancy_id !== undefined) { + this.params.redundancy_id = redundancy_id; + } + + if (count !== undefined) { + this.params.count = count; + } + if (first !== undefined) { + this.params.first = first; + } + } + + public parse (response: response.JsonrpcBaseResponse): SyslogBrowseResponse | null { + + const logger = pino.pino(); + + if (response.is_error() || !response.result) { + logger.error('Response has error or response result does not exist'); + return null; + } + + const responseProcess = new SyslogBrowseResponse(); + const responseR = new SyslogBrowseResponse(); + let container : SyslogBrowseStructure = new SyslogBrowseStructure(); + let Vars: SyslogBrowseStructure | null = null; + responseProcess.result = response.result; + if (responseProcess.result !== undefined) { + + Vars = new SyslogBrowseStructure(); + for (const [key, value] of Object.entries(response.result) as [string, any]) { // Only returns a Record, not an array of arrays + + if (Vars !== null) { + if (key === 'count_total') { + Vars.count_total = Number(value) || 0; + } + if (key === 'count_lost') { + Vars.count_lost = Number(value) || 0; + } + if (key === 'entries') { + for (const content of value) { + const entry = new SyslogData(); + entry.raw = content || ''; + Vars.entries.push(entry); + } + + } + + } + } + if (Vars !== null) { + container = Vars; + } + } + responseR.error = response.error; + responseR.id = response.id; + responseR.result = container; + return responseR; + } +} + +export class SyslogBrowseResponse extends response.JsonrpcBaseResponse { + result?: SyslogBrowseStructure; + constructor () { + super('SyslogBrowse'); + } +} + diff --git a/src/ticket.ts b/src/ticket.ts new file mode 100644 index 0000000..34d86d7 --- /dev/null +++ b/src/ticket.ts @@ -0,0 +1,257 @@ +import pino from 'pino'; +import axios, { AxiosResponse } from 'axios'; +import * as request from './request'; +import * as response from './response'; +import https from 'https'; +export class TicketDownloadData extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, ticket_id: string, token?: string) { + const method = 'NotUsed'; + const params = { id: ticket_id }; + super(config.address, config.protocol, config.verifyTls, method, params, token, undefined, undefined, config.plcCertificate); + } + + public body () { + /** + * Overwrites the body method of base request. + * No body is needed for ticket requests + * */ + return null; + } + + public url () { + /** + * Creates the url based on the information address and protocol + * Differs from base JSONRPC request in the route params + */ + let id; + if (this.params) { + id = this.params.id; + } + return `${this.protocol}://${this.address}/api/ticket?id=${id}`; + } + + public async request (): Promise { + try { + + this.response = await axios.get(this.url(), { headers: this.headers(), httpsAgent: this.gethttpsAgent() }); + return this.response; + + } catch (error) { + console.error(error); + throw error; + } + + } + + public async execute (): Promise { + const get_res = await this.request(); + const logger = pino(); + logger.debug(this.__str__()); + logger.debug(this.format_response()); + + if (get_res == null) { + logger.error('Response was empty, unable to parse'); + + return null; + } + const res = new response.JsonrpcBaseResponse(); + + // I'm doing the same than inthe parse method of response but I'm not calling it because in upload I need to check also if its 204 + if (Number(get_res.status) !== 200 && Number(get_res.status) !== 204) { + logger.error(`Failed to retrieve data from ticket ${this.params}, request returned response code ${get_res.status} `); + console.log(`Failed to retrieve data from ticket ${this.params}, request returned response code ${get_res.status} `); + return null; + } + const json_response = get_res.data; + + if (json_response !== undefined) { + + res.result = json_response; + return res; + } + + if (json_response.error !== undefined) { + let msg = null; + let code = -1; + if (json_response.error.message !== undefined) { + msg = json_response.error.message; + } + if (json_response.error.code !== undefined) { + code = json_response.error.code; + } + + res.error = new response.JsonrpcError(get_res.status, code, msg); + return res; + } + return null; + } +} + +export class TicketUploadData extends TicketDownloadData { + data: Uint8Array; + constructor (config: request.RequestConfig, ticket_id: string, data: Uint8Array, token: string) { + super(config, ticket_id, token); + this.data = data; + } + + public headers (): Record { + if (this.token !== undefined) { + return { + 'Content-type': 'application/octet-stream', + 'X-Auth-Token': this.token + }; + } + return { 'Content-type': 'application/octet-stream' }; + } + + public async request (): Promise { + try { + + this.response = await axios.post(this.url(), this.data, { headers: this.headers(), httpsAgent: this.gethttpsAgent() }); + + return this.response; + + } catch (error) { + console.error(error); + throw error; + } + + } + + public async execute (): Promise { + const ExecuteResponse = new response.JsonrpcBaseResponse(); + const post_res = await this.request(); + const logger = pino(); + + logger.debug(this.__str__()); + logger.debug(this.format_response()); + + if (post_res == null) { + logger.error('Response was empty, unable to parse'); + console.log('Response was empty, unable to parse'); + return null; + } + + if (Number(post_res.status) !== 200 && Number(post_res.status) !== 204) { // Still receiving number 204 NO CONTENT when Im uploading + logger.error(`Failed to retrieve data from ticket ${this.params}, request returned response code ${post_res.status} `); + console.log(`Failed to retrieve data from ticket ${this.params}, request returned response code ${post_res.status} `); + return null; + } + const json_response = post_res.data; + + if (json_response !== undefined) { + console.log('UPLOAD DATA', json_response); + ExecuteResponse.result = json_response; + return ExecuteResponse; + } + return null; + + } + +} + +export class ProxyTicketDownloadData extends TicketDownloadData { + proxyAddress: string; + + constructor (config: request.RequestConfig, ticket_id: string, proxyAddress: string, token?: string) { + super(config, ticket_id, token); + this.proxyAddress = proxyAddress; + } + + public url () { + /** + * Creates the url based on the proxy server address + */ + let id; + if (this.params) { + id = this.params.id; + } + return `${this.proxyAddress}/api/ticket?id=${id}`; + } + + public headers (): Record { + if (this.token !== undefined) { + return { + 'Content-type': 'application/octet-stream', + 'X-Auth-Token': this.token, + 'x-plc-ip': this.address + }; + } + return { 'Content-type': 'application/octet-stream' }; + } +} + +export class ProxyTicketUploadData { + proxyAddress: string; + data: Uint8Array; + token: string; + address: string; // PLC IP address + ticket_id: string; + + constructor (proxyAddress: string, address: string, ticket_id: string, data: Uint8Array, token: string) { + this.proxyAddress = proxyAddress; + this.address = address; + this.ticket_id = ticket_id; + this.data = data; + this.token = token; + } + + public headers () { + return { + 'Content-type': 'application/octet-stream', + 'X-Auth-Token': this.token, + 'x-plc-ip': this.address, // Send the PLC IP to the proxy + 'x-plc-ticket': this.ticket_id // Send the ticket ID to the proxy + }; + } + + public url () { + /** + * Creates the url based on the proxy server address + */ + + return `${this.proxyAddress}/api/ticket-upload`; + } + + public gethttpsAgent (): https.Agent | undefined { + + return new https.Agent({ rejectUnauthorized: false }); + + } + + public async request (): Promise { + try { + // Send the data to the proxy + const response = await axios.post(this.url(), this.data, { + headers: this.headers(), + httpsAgent: this.gethttpsAgent() + }); + return response; + } catch (error) { + console.error('Error uploading to proxy:', error); + throw error; + } + } + + public async execute (): Promise { + const logger = pino(); + try { + const post_res = await this.request(); + + logger.debug(`Request to proxy was successful: ${post_res.status}`); + if (post_res.status !== 200 && post_res.status !== 204) { + logger.error(`Failed to upload to proxy. Response code: ${post_res.status}`); + return null; + } + + const json_response = post_res.data; + const executeResponse = new response.JsonrpcBaseResponse(); + executeResponse.result = json_response; + + return executeResponse; + } catch (error) { + logger.error('Error in execute method:', error); + return null; + } + } +} diff --git a/src/webApp.ts b/src/webApp.ts new file mode 100644 index 0000000..f5bad95 --- /dev/null +++ b/src/webApp.ts @@ -0,0 +1,616 @@ +import * as request from './request'; +import * as response from './response'; +import * as pino from 'pino'; + +export class WebAppCreate extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, name: string, state?: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + this.method = 'WebApp.Create'; + if (state) { + this.params = { name, state }; + } else { + this.params = { name, state: 'enabled' }; // Default value + } + + } + + public parse (response: response.JsonrpcBaseResponse): WebAppCreateResponse | null { + const responseR = new WebAppCreateResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} + +export class WebAppCreateResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('WebAppCreate'); + } +} +export class WebAppDelete extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, name: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + this.method = 'WebApp.Delete'; + this.params = { name }; + } + + public parse (response: response.JsonrpcBaseResponse): WebAppDeleteResponse | null { + const responseR = new WebAppDeleteResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class WebAppDeleteResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('WebAppDelete'); + } +} + +export class WebAppRename extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, name: string, new_name: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'WebApp.Rename'; + this.params = { name, new_name }; + + } + + public parse (response: response.JsonrpcBaseResponse): WebAppRenameResponse | null { + const responseR = new WebAppRenameResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } + +} +export class WebAppRenameResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('WebAppRename'); + } +} +export class WebAppRenameResource extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, app_name: string, name: string, new_name: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + this.method = 'WebApp.RenameResource'; + this.params = { app_name, name, new_name }; + } + + public parse (response: response.JsonrpcBaseResponse): WebAppRenameResourceResponse | null { + const responseR = new WebAppRenameResourceResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class WebAppRenameResourceResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('WebAppRenameResource'); + } +} +export class WebAppSetState extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, name: string, state: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'WebApp.SetState'; + this.params = { name, state }; + + } + + public parse (response: response.JsonrpcBaseResponse): WebAppSetStateResponse | null { + const responseR = new WebAppSetStateResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class WebAppSetStateResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('WebAppSetState'); + } +} + +export class WebAppSetDefaultPage extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, name: string, resource_name: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'WebApp.SetDefaultPage'; + this.params = { name, resource_name }; + } + + public parse (response: response.JsonrpcBaseResponse): WebAppSetDefaultPageResponse | null { + const responseR = new WebAppSetDefaultPageResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class WebAppSetDefaultPageResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('WebAppSetDefaultPage'); + } +} + +export class WebAppSetNotFoundPage extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, name: string, resource_name: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'WebApp.SetNotFoundPage'; + this.params = { name, resource_name }; + } + + public parse (response: response.JsonrpcBaseResponse): WebAppSetNotFoundPageResponse | null { + const responseR = new WebAppSetNotFoundPageResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class WebAppSetNotFoundPageResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('WebAppSetNotFoundPage'); + } +} + +export class WebAppSetNotAuthorizedPage extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, name: string, resource_name: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'WebApp.SetNotAuthorizedPage'; + this.params = { name, resource_name }; + } + + public parse (response: response.JsonrpcBaseResponse): WebAppSetNotAuthorizedPageResponse | null { + const responseR = new WebAppSetNotAuthorizedPageResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class WebAppSetNotAuthorizedPageResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('WebAppSetNotAuthorizedPage'); + } +} +export class WebAppCreateResource extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, app_name: string, name: string, media_type: string, last_modified: string, visibility?: string, etag?: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'WebApp.CreateResource'; + + if (visibility && etag) { + this.params = { app_name, name, media_type, visibility, etag, last_modified }; + } else if (visibility && !etag) { + this.params = { app_name, name, media_type, visibility, etag: '', last_modified }; + } else if (etag && !visibility) { + this.params = { app_name, name, media_type, visibility: 'public', etag, last_modified }; + } else { + this.params = { app_name, name, media_type, visibility: 'public', etag: '', last_modified }; + } + } + + public parse (response: response.JsonrpcBaseResponse): WebAppCreateResourceResponse | null { + const responseR = new WebAppCreateResourceResponse(); + responseR.error = response.error; + responseR.id = response.id; + + if (response.is_error() === true && response.result === null) { + return null; + } + if (response.result && typeof response.result === 'string') { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class WebAppCreateResourceResponse extends response.JsonrpcBaseResponse { + result?: string; + constructor () { + super('WebAppCreateResource'); + } +} +export class WebAppDeleteResource extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, app_name: string, name: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'WebApp.DeleteResource'; + this.params = { app_name, name }; + + } + + public parse (response: response.JsonrpcBaseResponse): WebAppDeleteResourceResponse | null { + const responseR = new WebAppDeleteResourceResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class WebAppDeleteResourceResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('WebAppDeleteResource'); + } +} +export class WebAppDownloadResource extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, app_name: string, name: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'WebApp.DownloadResource'; + this.params = { app_name, name }; + + } + + public parse (response: response.JsonrpcBaseResponse): WebAppDownloadResourceResponse | null { + const responseR = new WebAppDownloadResourceResponse(); + responseR.error = response.error; + responseR.id = response.id; + + if (response.is_error() === true && response.result === null) { + return null; + } + if (response.result && typeof response.result === 'string') { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class WebAppDownloadResourceResponse extends response.JsonrpcBaseResponse { + result?: string; + constructor () { + super('WebAppDownloadResource'); + } +} + +export class WebAppSetResourceETag extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, app_name: string, name: string, etag: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'WebApp.SetResourceETag'; + this.params = { app_name, name, etag }; + } + + public parse (response: response.JsonrpcBaseResponse): WebAppSetResourceETagResponse | null { + const responseR = new WebAppSetResourceETagResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class WebAppSetResourceETagResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('WebAppSetResourceETag'); + } +} + +export class WebAppSetResourceMediaType extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, app_name: string, name: string, media_type: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'WebApp.SetResourceMediaType'; + this.params = { app_name, name, media_type }; + } + + public parse (response: response.JsonrpcBaseResponse): WebAppSetResourceMediaTypeResponse | null { + const responseR = new WebAppSetResourceMediaTypeResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class WebAppSetResourceMediaTypeResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('WebAppSetResourceMediaType'); + } +} +export class WebAppSetResourceModificationTime extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, app_name: string, name: string, last_modified: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'WebApp.SetResourceModificationTime'; + this.params = { app_name, name, last_modified }; + } + + public parse (response: response.JsonrpcBaseResponse): WebAppSetResourceModificationTimeResponse | null { + const responseR = new WebAppSetResourceModificationTimeResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class WebAppSetResourceModificationTimeResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('WebAppSetResourceModificationTime'); + } +} + +export class WebAppSetResourceVisibility extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, app_name: string, name: string, visibility: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'WebApp.SetResourceVisibility'; + this.params = { app_name, name, visibility }; + } + + public parse (response: response.JsonrpcBaseResponse): WebAppSetResourceVisibilityResponse | null { + const responseR = new WebAppSetResourceVisibilityResponse(); + responseR.error = response.error; + responseR.id = response.id; + if ((response.is_error() === true) || (response.result === null)) { + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + } +} +export class WebAppSetResourceVisibilityResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('WebAppSetResourceVisibility'); + } +} + +export class Application { + name: string = ''; + state: string = ''; + type: string = ''; +} + +export class BrowseStructure { + max_applications: number = 0; + applications: Application[] = []; +} + +export class WebAppBrowse extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, name?: string) { + super(config.address, config.protocol, config.verifyTls); + + this.method = 'WebApp.Browse'; + if (name) { + this.params = { name }; + } + } + + public parse (response: response.JsonrpcBaseResponse): WebAppBrowseResponse | null { + const logger = pino.pino(); + if (response.is_error() || !response.result) { + logger.error('Response has error or response result does not exist'); + return null; + } + if (response.result.applications === undefined) { + console.log('An application with this name does not exist.'); + logger.error('An application with this name does not exist.'); + return null; + } + + let container: BrowseStructure = new BrowseStructure(); + const responseR = new WebAppBrowseResponse(); + const responseProcess = new WebAppBrowseResponse(); + let Var : BrowseStructure | null = null; + responseProcess.result = response.result; + + if (responseProcess.result !== undefined) { + for (const [key, value] of Object.entries(responseProcess.result) as [string, unknown][]) { + + if (typeof key === 'string' && key === 'max_applications') { + Var = new BrowseStructure(); + Var.max_applications = Number(value) || 0; + // I only create the instance when I find max_applications because it only appears once! + // Necessary to check if in key there is an string. + } else if (key === 'applications' && Var !== null) { + if (Array.isArray(value)) { + for (const content of value) { + const app = new Application(); + app.name = content.name || ''; + app.state = content.state || ''; + app.type = content.type || ''; + + Var.applications.push(app); + } + } + } + } + if (Var !== null) { + container = Var; + } + } + responseR.error = response.error; + responseR.id = response.id; + responseR.result = container; + return responseR; + } +} +export class WebAppBrowseResponse extends response.JsonrpcBaseResponse { + result?: BrowseStructure; + constructor () { + super('WebAppBrowse'); + } +} + +export class Resource { + name: string = ''; + size: number = 0; + media_type : string = ''; + etag ?: string; + visibility: string = ''; + last_modified: string = ''; +} +export class BrowseResourcesStructure { + max_resources : number = 0; + resources : Resource[] = []; +} +export class WebAppBrowseResources extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, app_name: string, name?: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'WebApp.BrowseResources'; + if (name !== undefined) { + this.params = { app_name, name }; + } else { + this.params = { app_name }; + } + } + + public parse (response: response.JsonrpcBaseResponse): WebAppBrowseResourcesResponse | null { + const logger = pino.pino(); + if (response.is_error() || !response.result) { + logger.error('Response has error or response result does not exist'); + return null; + } + if (response.result.resources.length <= 0) { + console.log('An application with this name does not exist.'); + logger.error('An application with this name does not exist.'); + return null; + } + + let container: BrowseResourcesStructure = new BrowseResourcesStructure(); + const responseR = new WebAppBrowseResourcesResponse(); + const responseProcess = new WebAppBrowseResourcesResponse(); + let Var : BrowseResourcesStructure | null = null; + responseProcess.result = response.result; + + if (responseProcess.result !== undefined) { + for (const [key, value] of Object.entries(responseProcess.result) as [string, unknown][]) { + + if (typeof key === 'string' && key === 'max_resources') { + if (Var == null) { + Var = new BrowseResourcesStructure(); + } + // I only create the instance when I find max_applications because it only appears once! + // Necessary to check if in key there is an string. + Var.max_resources = Number(value) || 0; + + } else if (key === 'resources' && Var !== null) { + if (Array.isArray(value)) { + for (const content of value) { + const resource = new Resource(); + resource.name = content.name || ''; + resource.size = content.size || 0; + resource.media_type = content.media_type || ''; + resource.etag = content.etag || undefined; + resource.visibility = content.visibility || ''; + resource.last_modified = content.last_modified || ''; + + Var.resources.push(resource); + + } + } + } + } + if (Var !== null) { + container = Var; + } + } + responseR.error = response.error; + responseR.id = response.id; + responseR.result = container; + return responseR; + } + +} + +export class WebAppBrowseResourcesResponse extends response.JsonrpcBaseResponse { + result?: BrowseResourcesStructure; + constructor () { + super('WebAppBrowseResources'); + } +} diff --git a/src/webserver.ts b/src/webserver.ts new file mode 100644 index 0000000..52e7792 --- /dev/null +++ b/src/webserver.ts @@ -0,0 +1,86 @@ +import * as response from './response'; +import * as request from './request'; +import * as pino from 'pino'; + +export class WebServerSetDefaultPage extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig, token: string, default_page: string) { + super(config.address, config.protocol, config.verifyTls, undefined, undefined, token); + + this.method = 'WebServer.SetDefaultPage'; + this.params = { default_page }; + } + + public parse (response: response.JsonrpcBaseResponse): WebServerSetDefaultPageResponse | null { + const logger = pino.pino(); + logger.level = 'debug'; + // transport: { + // target: 'pino-pretty', + // options: {} + // } + // }); + + const responseR = new WebServerSetDefaultPageResponse(); + + responseR.error = response.error; + responseR.id = response.id; + if (response.is_error() || !response.result) { + logger.error('Response has error or response result does not exist'); + return null; + } + if (response.result) { + responseR.result = response.result; + return responseR; + } + return null; + + } +} +export class WebServerSetDefaultPageResponse extends response.JsonrpcBaseResponse { + result?: boolean; + constructor () { + super('WebServerSetDefaultPage'); + } +} + +export class WebServerReadDefaultPage extends request.JsonrpcBaseRequest { + constructor (config: request.RequestConfig) { + super(config.address, config.protocol, config.verifyTls); + + this.method = 'WebServer.ReadDefaultPage'; + } + + public parse (response: response.JsonrpcBaseResponse): WebServerReadDefaultPageResponse | null { + // const logger = pino.pino({ + // level: 'debug', + // transport:{ + // target: 'pino-pretty' + // } + // }); + const logger = pino.pino(); + logger.level = 'debug'; + + const responseR = new WebServerReadDefaultPageResponse(); + + responseR.error = response.error; + responseR.id = response.id; + + if (response.is_error() || !response.result) { + logger.error('Response has error or response result does not exist'); + return null; + } + if (response.result && typeof response.result.default_page === 'string') { + responseR.result = response.result.default_page; + return responseR; + } + return null; + } + +} + +export class WebServerReadDefaultPageResponse extends response.JsonrpcBaseResponse { + result?: string; + + constructor () { + super('WebServerReadDefaultPageResponse'); + } +} diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..a5e2439 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,115 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "ES2019", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + + /* Modules */ + "module": "commonjs", /* Specify what module code is generated. */ + // "rootDir": "./", /* Specify the root folder within your source files. */ + "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ + // "types": [], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */ + // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */ + // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */ + // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + + /* Emit */ + "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + "outDir": "./dist", /* Specify an output folder for all emitted files. */ + "removeComments": false, /* Disable emitting comments. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ + + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */ + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ + + /* Type Checking */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + }, + "include": [ + "src/**/*.ts" + ], + "exclude": [ + "node_modules" + ] +}