@autorest/typescript 6.0.0-beta.9 → 6.0.0-rc.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +42 -5
- package/dist/{src/generators/static/README.md.hbs → hlcREADME.md.hbs} +35 -3
- package/dist/hlcSamples.ts.hbs +49 -0
- package/dist/karma.conf.js.hbs +126 -0
- package/dist/paginateHelper.ts.hbs +208 -0
- package/dist/pollingHelper.ts.hbs +72 -0
- package/dist/rlcEnv.ts.hbs +3 -0
- package/dist/rlcREADME.md.hbs +71 -0
- package/dist/rlcRecordedClient.ts.hbs +26 -0
- package/dist/rlcSampleTest.spec.ts.hbs +20 -0
- package/dist/rlcSamples.ts.hbs +28 -0
- package/dist/sampleEnv.hbs +4 -0
- package/dist/sampleTest.ts.hbs +32 -0
- package/dist/samples.ts.hbs +0 -0
- package/dist/src/autorestSession.d.ts +17 -6
- package/dist/src/autorestSession.d.ts.map +1 -1
- package/dist/src/autorestSession.js +3 -9
- package/dist/src/autorestSession.js.map +1 -1
- package/dist/src/conflictResolver.d.ts +3 -0
- package/dist/src/conflictResolver.d.ts.map +1 -0
- package/dist/src/conflictResolver.js +43 -0
- package/dist/src/conflictResolver.js.map +1 -0
- package/dist/src/generators/LROGenerator.js +4 -4
- package/dist/src/generators/LROGenerator.js.map +1 -1
- package/dist/src/generators/clientFileGenerator.d.ts.map +1 -1
- package/dist/src/generators/clientFileGenerator.js +300 -46
- package/dist/src/generators/clientFileGenerator.js.map +1 -1
- package/dist/src/generators/indexGenerator.d.ts.map +1 -1
- package/dist/src/generators/indexGenerator.js +106 -14
- package/dist/src/generators/indexGenerator.js.map +1 -1
- package/dist/src/generators/mappersGenerator.d.ts.map +1 -1
- package/dist/src/generators/mappersGenerator.js +93 -19
- package/dist/src/generators/mappersGenerator.js.map +1 -1
- package/dist/src/generators/modelsGenerator.d.ts.map +1 -1
- package/dist/src/generators/modelsGenerator.js +80 -81
- package/dist/src/generators/modelsGenerator.js.map +1 -1
- package/dist/src/generators/operationGenerator.d.ts.map +1 -1
- package/dist/src/generators/operationGenerator.js +85 -96
- package/dist/src/generators/operationGenerator.js.map +1 -1
- package/dist/src/generators/operationInterfaceGenerator.js +20 -20
- package/dist/src/generators/operationInterfaceGenerator.js.map +1 -1
- package/dist/src/generators/parametersGenerator.d.ts.map +1 -1
- package/dist/src/generators/parametersGenerator.js +7 -8
- package/dist/src/generators/parametersGenerator.js.map +1 -1
- package/dist/src/generators/samples/hlcSampleGenerator.d.ts +13 -0
- package/dist/src/generators/samples/hlcSampleGenerator.d.ts.map +1 -0
- package/dist/src/generators/samples/hlcSampleGenerator.js +43 -0
- package/dist/src/generators/samples/hlcSampleGenerator.js.map +1 -0
- package/dist/src/generators/samples/hlcSamples.ts.hbs +49 -0
- package/dist/src/generators/samples/rlcSampleGenerator.d.ts +4 -0
- package/dist/src/generators/samples/rlcSampleGenerator.d.ts.map +1 -0
- package/dist/src/generators/samples/rlcSampleGenerator.js +64 -0
- package/dist/src/generators/samples/rlcSampleGenerator.js.map +1 -0
- package/dist/src/generators/samples/rlcSamples.ts.hbs +28 -0
- package/dist/src/generators/samples/sampleEnv.hbs +4 -0
- package/dist/src/generators/samples/sampleEnvGenerator.d.ts +3 -0
- package/dist/src/generators/samples/sampleEnvGenerator.d.ts.map +1 -0
- package/dist/src/generators/samples/sampleEnvGenerator.js +17 -0
- package/dist/src/generators/samples/sampleEnvGenerator.js.map +1 -0
- package/dist/src/generators/static/apiExtractorConfig.js +2 -2
- package/dist/src/generators/static/apiExtractorConfig.js.map +1 -1
- package/dist/src/generators/static/esLintConfigGenerator.d.ts +3 -0
- package/dist/src/generators/static/esLintConfigGenerator.d.ts.map +1 -0
- package/dist/src/generators/static/esLintConfigGenerator.js +26 -0
- package/dist/src/generators/static/esLintConfigGenerator.js.map +1 -0
- package/{src/generators/static/README.md.hbs → dist/src/generators/static/hlcREADME.md.hbs} +35 -3
- package/dist/src/generators/static/karma.conf.js.hbs +126 -0
- package/dist/src/generators/static/karmaConfigFileGenerator.d.ts +3 -0
- package/dist/src/generators/static/karmaConfigFileGenerator.d.ts.map +1 -0
- package/dist/src/generators/static/karmaConfigFileGenerator.js +23 -0
- package/dist/src/generators/static/karmaConfigFileGenerator.js.map +1 -0
- package/dist/src/generators/static/licenseFileGenerator.js +1 -1
- package/dist/src/generators/static/licenseFileGenerator.js.map +1 -1
- package/dist/src/generators/static/packageFileGenerator.d.ts.map +1 -1
- package/dist/src/generators/static/packageFileGenerator.js +255 -67
- package/dist/src/generators/static/packageFileGenerator.js.map +1 -1
- package/dist/src/generators/static/readmeFileGenerator.d.ts +2 -2
- package/dist/src/generators/static/readmeFileGenerator.d.ts.map +1 -1
- package/dist/src/generators/static/readmeFileGenerator.js +50 -23
- package/dist/src/generators/static/readmeFileGenerator.js.map +1 -1
- package/dist/src/generators/static/rlcREADME.md.hbs +71 -0
- package/dist/src/generators/static/rollupConfigFileGenerator.d.ts.map +1 -1
- package/dist/src/generators/static/rollupConfigFileGenerator.js +12 -71
- package/dist/src/generators/static/rollupConfigFileGenerator.js.map +1 -1
- package/dist/src/generators/static/tsConfigFileGenerator.d.ts.map +1 -1
- package/dist/src/generators/static/tsConfigFileGenerator.js +46 -18
- package/dist/src/generators/static/tsConfigFileGenerator.js.map +1 -1
- package/dist/src/generators/test/envBrowserFileGenerator.d.ts +3 -0
- package/dist/src/generators/test/envBrowserFileGenerator.d.ts.map +1 -0
- package/dist/src/generators/test/envBrowserFileGenerator.js +15 -0
- package/dist/src/generators/test/envBrowserFileGenerator.js.map +1 -0
- package/dist/src/generators/test/envFileGenerator.d.ts +3 -0
- package/dist/src/generators/test/envFileGenerator.d.ts.map +1 -0
- package/dist/src/generators/test/envFileGenerator.js +23 -0
- package/dist/src/generators/test/envFileGenerator.js.map +1 -0
- package/dist/src/generators/test/recordedClientFileGenerator.d.ts +3 -0
- package/dist/src/generators/test/recordedClientFileGenerator.d.ts.map +1 -0
- package/dist/src/generators/test/recordedClientFileGenerator.js +23 -0
- package/dist/src/generators/test/recordedClientFileGenerator.js.map +1 -0
- package/dist/src/generators/test/rlcEnv.ts.hbs +3 -0
- package/dist/src/generators/test/rlcRecordedClient.ts.hbs +26 -0
- package/dist/src/generators/test/rlcSampleTest.spec.ts.hbs +20 -0
- package/dist/src/generators/test/sampleTest.ts.hbs +32 -0
- package/dist/src/generators/test/sampleTestGenerator.d.ts +3 -0
- package/dist/src/generators/test/sampleTestGenerator.d.ts.map +1 -0
- package/dist/src/generators/test/sampleTestGenerator.js +34 -0
- package/dist/src/generators/test/sampleTestGenerator.js.map +1 -0
- package/dist/src/generators/tracingFileGenerator.d.ts.map +1 -1
- package/dist/src/generators/tracingFileGenerator.js +7 -21
- package/dist/src/generators/tracingFileGenerator.js.map +1 -1
- package/dist/src/generators/utils/docsUtils.js +2 -2
- package/dist/src/generators/utils/docsUtils.js.map +1 -1
- package/dist/src/generators/utils/operationsUtils.js +1 -1
- package/dist/src/generators/utils/operationsUtils.js.map +1 -1
- package/dist/src/generators/utils/pagingOperations.d.ts +5 -0
- package/dist/src/generators/utils/pagingOperations.d.ts.map +1 -1
- package/dist/src/generators/utils/pagingOperations.js +15 -15
- package/dist/src/generators/utils/pagingOperations.js.map +1 -1
- package/dist/src/generators/utils/parameterUtils.js +9 -9
- package/dist/src/generators/utils/parameterUtils.js.map +1 -1
- package/dist/src/generators/utils/responseTypeUtils.js +2 -2
- package/dist/src/generators/utils/responseTypeUtils.js.map +1 -1
- package/dist/src/generators/utils/tracingUtils.d.ts.map +1 -1
- package/dist/src/generators/utils/tracingUtils.js +2 -6
- package/dist/src/generators/utils/tracingUtils.js.map +1 -1
- package/dist/src/main.d.ts +2 -2
- package/dist/src/main.d.ts.map +1 -1
- package/dist/src/main.js +8 -8
- package/dist/src/main.js.map +1 -1
- package/dist/src/models/clientDetails.d.ts +10 -1
- package/dist/src/models/clientDetails.d.ts.map +1 -1
- package/dist/src/models/modelDetails.d.ts +2 -2
- package/dist/src/models/modelDetails.d.ts.map +1 -1
- package/dist/src/models/operationDetails.d.ts +1 -0
- package/dist/src/models/operationDetails.d.ts.map +1 -1
- package/dist/src/models/sampleDetails.d.ts +22 -0
- package/dist/src/models/sampleDetails.d.ts.map +1 -0
- package/dist/src/models/sampleDetails.js +3 -0
- package/dist/src/models/sampleDetails.js.map +1 -0
- package/dist/src/restLevelClient/generateClient.d.ts +1 -1
- package/dist/src/restLevelClient/generateClient.d.ts.map +1 -1
- package/dist/src/restLevelClient/generateClient.js +108 -167
- package/dist/src/restLevelClient/generateClient.js.map +1 -1
- package/dist/src/restLevelClient/generateClientDefinition.d.ts +6 -0
- package/dist/src/restLevelClient/generateClientDefinition.d.ts.map +1 -0
- package/dist/src/restLevelClient/generateClientDefinition.js +261 -0
- package/dist/src/restLevelClient/generateClientDefinition.js.map +1 -0
- package/dist/src/restLevelClient/generateIsUnexpectedHelper.d.ts +8 -0
- package/dist/src/restLevelClient/generateIsUnexpectedHelper.d.ts.map +1 -0
- package/dist/src/restLevelClient/generateIsUnexpectedHelper.js +204 -0
- package/dist/src/restLevelClient/generateIsUnexpectedHelper.js.map +1 -0
- package/dist/src/restLevelClient/generateMethodShortcuts.d.ts +8 -0
- package/dist/src/restLevelClient/generateMethodShortcuts.d.ts.map +1 -0
- package/dist/src/restLevelClient/generateMethodShortcuts.js +70 -0
- package/dist/src/restLevelClient/generateMethodShortcuts.js.map +1 -0
- package/dist/src/restLevelClient/generateObjectTypes.d.ts +3 -3
- package/dist/src/restLevelClient/generateObjectTypes.d.ts.map +1 -1
- package/dist/src/restLevelClient/generateObjectTypes.js +43 -31
- package/dist/src/restLevelClient/generateObjectTypes.js.map +1 -1
- package/dist/src/restLevelClient/generatePagingHelper.d.ts +3 -0
- package/dist/src/restLevelClient/generatePagingHelper.d.ts.map +1 -0
- package/dist/src/restLevelClient/generatePagingHelper.js +54 -0
- package/dist/src/restLevelClient/generatePagingHelper.js.map +1 -0
- package/dist/src/restLevelClient/generateParameterTypes.d.ts.map +1 -1
- package/dist/src/restLevelClient/generateParameterTypes.js +247 -44
- package/dist/src/restLevelClient/generateParameterTypes.js.map +1 -1
- package/dist/src/restLevelClient/generatePollingHelper.d.ts +3 -0
- package/dist/src/restLevelClient/generatePollingHelper.d.ts.map +1 -0
- package/dist/src/restLevelClient/generatePollingHelper.js +20 -0
- package/dist/src/restLevelClient/generatePollingHelper.js.map +1 -0
- package/dist/src/restLevelClient/generateResponseTypes.d.ts.map +1 -1
- package/dist/src/restLevelClient/generateResponseTypes.js +35 -23
- package/dist/src/restLevelClient/generateResponseTypes.js.map +1 -1
- package/dist/src/restLevelClient/generateRestLevel.d.ts.map +1 -1
- package/dist/src/restLevelClient/generateRestLevel.js +63 -16
- package/dist/src/restLevelClient/generateRestLevel.js.map +1 -1
- package/dist/src/restLevelClient/generateSchemaTypes.d.ts.map +1 -1
- package/dist/src/restLevelClient/generateSchemaTypes.js +29 -7
- package/dist/src/restLevelClient/generateSchemaTypes.js.map +1 -1
- package/dist/src/restLevelClient/generateTopLevelIndexFile.d.ts +4 -0
- package/dist/src/restLevelClient/generateTopLevelIndexFile.d.ts.map +1 -0
- package/dist/src/restLevelClient/generateTopLevelIndexFile.js +37 -0
- package/dist/src/restLevelClient/generateTopLevelIndexFile.js.map +1 -0
- package/dist/src/restLevelClient/getPropertySignature.d.ts +2 -2
- package/dist/src/restLevelClient/getPropertySignature.d.ts.map +1 -1
- package/dist/src/restLevelClient/getPropertySignature.js +10 -7
- package/dist/src/restLevelClient/getPropertySignature.js.map +1 -1
- package/dist/src/restLevelClient/helpers/hasPollingOperations.d.ts +4 -0
- package/dist/src/restLevelClient/helpers/hasPollingOperations.d.ts.map +1 -0
- package/dist/src/restLevelClient/helpers/hasPollingOperations.js +12 -0
- package/dist/src/restLevelClient/helpers/hasPollingOperations.js.map +1 -0
- package/dist/src/restLevelClient/helpers/modelHelpers.d.ts +4 -0
- package/dist/src/restLevelClient/helpers/modelHelpers.d.ts.map +1 -0
- package/dist/src/restLevelClient/helpers/modelHelpers.js +19 -0
- package/dist/src/restLevelClient/helpers/modelHelpers.js.map +1 -0
- package/dist/src/restLevelClient/helpers/operationHelpers.d.ts +10 -0
- package/dist/src/restLevelClient/helpers/operationHelpers.d.ts.map +1 -0
- package/dist/src/restLevelClient/helpers/operationHelpers.js +64 -0
- package/dist/src/restLevelClient/helpers/operationHelpers.js.map +1 -0
- package/dist/src/restLevelClient/interfaces.d.ts +33 -0
- package/dist/src/restLevelClient/interfaces.d.ts.map +1 -0
- package/dist/src/restLevelClient/interfaces.js +3 -0
- package/dist/src/restLevelClient/interfaces.js.map +1 -0
- package/dist/src/restLevelClient/mutateCodeModel.js +2 -2
- package/dist/src/restLevelClient/mutateCodeModel.js.map +1 -1
- package/dist/src/restLevelClient/operationHelpers.d.ts +4 -0
- package/dist/src/restLevelClient/operationHelpers.d.ts.map +1 -1
- package/dist/src/restLevelClient/operationHelpers.js +21 -10
- package/dist/src/restLevelClient/operationHelpers.js.map +1 -1
- package/dist/src/restLevelClient/paginateHelper.ts.hbs +208 -0
- package/dist/src/restLevelClient/pollingHelper.ts.hbs +72 -0
- package/dist/src/restLevelClient/samples/generateSamples.d.ts +23 -0
- package/dist/src/restLevelClient/samples/generateSamples.d.ts.map +1 -0
- package/dist/src/restLevelClient/samples/generateSamples.js +3 -0
- package/dist/src/restLevelClient/samples/generateSamples.js.map +1 -0
- package/dist/src/restLevelClient/samples/samples.ts.hbs +0 -0
- package/dist/src/restLevelClient/schemaHelpers.d.ts +8 -2
- package/dist/src/restLevelClient/schemaHelpers.d.ts.map +1 -1
- package/dist/src/restLevelClient/schemaHelpers.js +27 -12
- package/dist/src/restLevelClient/schemaHelpers.js.map +1 -1
- package/dist/src/transforms/extensions.js +10 -10
- package/dist/src/transforms/extensions.js.map +1 -1
- package/dist/src/transforms/groupTransforms.js +2 -2
- package/dist/src/transforms/groupTransforms.js.map +1 -1
- package/dist/src/transforms/mapperTransforms.d.ts.map +1 -1
- package/dist/src/transforms/mapperTransforms.js +29 -26
- package/dist/src/transforms/mapperTransforms.js.map +1 -1
- package/dist/src/transforms/objectTransforms.d.ts.map +1 -1
- package/dist/src/transforms/objectTransforms.js +42 -26
- package/dist/src/transforms/objectTransforms.js.map +1 -1
- package/dist/src/transforms/operationTransforms.d.ts.map +1 -1
- package/dist/src/transforms/operationTransforms.js +29 -26
- package/dist/src/transforms/operationTransforms.js.map +1 -1
- package/dist/src/transforms/optionsTransforms.js +1 -1
- package/dist/src/transforms/optionsTransforms.js.map +1 -1
- package/dist/src/transforms/parameterTransforms.d.ts.map +1 -1
- package/dist/src/transforms/parameterTransforms.js +43 -27
- package/dist/src/transforms/parameterTransforms.js.map +1 -1
- package/dist/src/transforms/samplesTransforms.d.ts +7 -0
- package/dist/src/transforms/samplesTransforms.d.ts.map +1 -0
- package/dist/src/transforms/samplesTransforms.js +293 -0
- package/dist/src/transforms/samplesTransforms.js.map +1 -0
- package/dist/src/transforms/transforms.d.ts +1 -2
- package/dist/src/transforms/transforms.d.ts.map +1 -1
- package/dist/src/transforms/transforms.js +26 -24
- package/dist/src/transforms/transforms.js.map +1 -1
- package/dist/src/transforms/urlTransforms.js +3 -3
- package/dist/src/transforms/urlTransforms.js.map +1 -1
- package/dist/src/typescriptGenerator.d.ts +2 -2
- package/dist/src/typescriptGenerator.d.ts.map +1 -1
- package/dist/src/typescriptGenerator.js +46 -46
- package/dist/src/typescriptGenerator.js.map +1 -1
- package/dist/src/utils/autorestOptions.d.ts +2 -2
- package/dist/src/utils/autorestOptions.d.ts.map +1 -1
- package/dist/src/utils/autorestOptions.js +141 -62
- package/dist/src/utils/autorestOptions.js.map +1 -1
- package/dist/src/utils/cloneOperation.js +2 -2
- package/dist/src/utils/cloneOperation.js.map +1 -1
- package/dist/src/utils/copyFiles.d.ts +2 -0
- package/dist/src/utils/copyFiles.d.ts.map +1 -0
- package/dist/src/utils/copyFiles.js +33 -0
- package/dist/src/utils/copyFiles.js.map +1 -0
- package/dist/src/utils/extractHeaders.js +4 -4
- package/dist/src/utils/extractHeaders.js.map +1 -1
- package/dist/src/utils/extractPaginationDetails.d.ts +5 -1
- package/dist/src/utils/extractPaginationDetails.d.ts.map +1 -1
- package/dist/src/utils/extractPaginationDetails.js +23 -10
- package/dist/src/utils/extractPaginationDetails.js.map +1 -1
- package/dist/src/utils/headersToSchema.js +1 -1
- package/dist/src/utils/headersToSchema.js.map +1 -1
- package/dist/src/utils/logger.js +1 -1
- package/dist/src/utils/logger.js.map +1 -1
- package/dist/src/utils/nameUtils.d.ts +6 -2
- package/dist/src/utils/nameUtils.d.ts.map +1 -1
- package/dist/src/utils/nameUtils.js +13 -8
- package/dist/src/utils/nameUtils.js.map +1 -1
- package/dist/src/utils/schemaHelpers.d.ts +6 -1
- package/dist/src/utils/schemaHelpers.d.ts.map +1 -1
- package/dist/src/utils/schemaHelpers.js +50 -7
- package/dist/src/utils/schemaHelpers.js.map +1 -1
- package/dist/src/utils/sortObjectSchemasHierarchically.js +1 -1
- package/dist/src/utils/sortObjectSchemasHierarchically.js.map +1 -1
- package/dist/src/utils/valueHelpers.js +1 -1
- package/dist/src/utils/valueHelpers.js.map +1 -1
- package/package.json +58 -39
- package/src/autorestSession.ts +25 -18
- package/src/conflictResolver.ts +61 -0
- package/src/generators/clientFileGenerator.ts +397 -36
- package/src/generators/indexGenerator.ts +118 -12
- package/src/generators/mappersGenerator.ts +108 -8
- package/src/generators/modelsGenerator.ts +98 -97
- package/src/generators/operationGenerator.ts +54 -93
- package/src/generators/parametersGenerator.ts +2 -3
- package/src/generators/samples/hlcSampleGenerator.ts +50 -0
- package/src/generators/samples/hlcSamples.ts.hbs +49 -0
- package/src/generators/samples/rlcSampleGenerator.ts +72 -0
- package/src/generators/samples/rlcSamples.ts.hbs +28 -0
- package/src/generators/samples/sampleEnv.hbs +4 -0
- package/src/generators/samples/sampleEnvGenerator.ts +14 -0
- package/src/generators/static/apiExtractorConfig.ts +2 -2
- package/src/generators/static/esLintConfigGenerator.ts +24 -0
- package/src/generators/static/hlcREADME.md.hbs +144 -0
- package/src/generators/static/karma.conf.js.hbs +126 -0
- package/src/generators/static/karmaConfigFileGenerator.ts +20 -0
- package/src/generators/static/packageFileGenerator.ts +292 -71
- package/src/generators/static/readmeFileGenerator.ts +79 -42
- package/src/generators/static/rlcREADME.md.hbs +71 -0
- package/src/generators/static/rollupConfigFileGenerator.ts +13 -71
- package/src/generators/static/tsConfigFileGenerator.ts +54 -19
- package/src/generators/test/envBrowserFileGenerator.ts +14 -0
- package/src/generators/test/envFileGenerator.ts +22 -0
- package/src/generators/test/recordedClientFileGenerator.ts +22 -0
- package/src/generators/test/rlcEnv.ts.hbs +3 -0
- package/src/generators/test/rlcRecordedClient.ts.hbs +26 -0
- package/src/generators/test/rlcSampleTest.spec.ts.hbs +20 -0
- package/src/generators/test/sampleTest.ts.hbs +32 -0
- package/src/generators/test/sampleTestGenerator.ts +32 -0
- package/src/generators/tracingFileGenerator.ts +6 -24
- package/src/generators/utils/pagingOperations.ts +1 -2
- package/src/generators/utils/tracingUtils.ts +1 -5
- package/src/main.ts +8 -5
- package/src/models/clientDetails.ts +11 -1
- package/src/models/modelDetails.ts +2 -2
- package/src/models/operationDetails.ts +1 -0
- package/src/models/sampleDetails.ts +22 -0
- package/src/restLevelClient/generateClient.ts +134 -244
- package/src/restLevelClient/generateClientDefinition.ts +386 -0
- package/src/restLevelClient/generateIsUnexpectedHelper.ts +224 -0
- package/src/restLevelClient/generateMethodShortcuts.ts +121 -0
- package/src/restLevelClient/generateObjectTypes.ts +62 -21
- package/src/restLevelClient/generatePagingHelper.ts +69 -0
- package/src/restLevelClient/generateParameterTypes.ts +377 -56
- package/src/restLevelClient/generatePollingHelper.ts +19 -0
- package/src/restLevelClient/generateResponseTypes.ts +36 -17
- package/src/restLevelClient/generateRestLevel.ts +63 -8
- package/src/restLevelClient/generateSchemaTypes.ts +43 -8
- package/src/restLevelClient/generateTopLevelIndexFile.ts +37 -0
- package/src/restLevelClient/getPropertySignature.ts +12 -4
- package/src/restLevelClient/helpers/hasPollingOperations.ts +15 -0
- package/src/restLevelClient/helpers/modelHelpers.ts +15 -0
- package/src/restLevelClient/helpers/operationHelpers.ts +93 -0
- package/src/restLevelClient/interfaces.ts +39 -0
- package/src/restLevelClient/operationHelpers.ts +23 -9
- package/src/restLevelClient/paginateHelper.ts.hbs +208 -0
- package/src/restLevelClient/pollingHelper.ts.hbs +72 -0
- package/src/restLevelClient/samples/generateSamples.ts +23 -0
- package/src/restLevelClient/samples/samples.ts.hbs +0 -0
- package/src/restLevelClient/schemaHelpers.ts +30 -8
- package/src/transforms/mapperTransforms.ts +11 -5
- package/src/transforms/objectTransforms.ts +26 -6
- package/src/transforms/operationTransforms.ts +6 -1
- package/src/transforms/parameterTransforms.ts +26 -7
- package/src/transforms/samplesTransforms.ts +349 -0
- package/src/transforms/transforms.ts +14 -9
- package/src/typescriptGenerator.ts +40 -53
- package/src/utils/autorestOptions.ts +198 -88
- package/src/utils/copyFiles.ts +36 -0
- package/src/utils/extractPaginationDetails.ts +19 -1
- package/src/utils/nameUtils.ts +18 -9
- package/src/utils/schemaHelpers.ts +51 -4
- package/CHANGELOG.md +0 -56
- package/dist/src/generators/clientContextFileGenerator.d.ts +0 -5
- package/dist/src/generators/clientContextFileGenerator.d.ts.map +0 -1
- package/dist/src/generators/clientContextFileGenerator.js +0 -263
- package/dist/src/generators/clientContextFileGenerator.js.map +0 -1
- package/src/generators/clientContextFileGenerator.ts +0 -405
package/README.md
CHANGED
|
@@ -53,9 +53,9 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio
|
|
|
53
53
|
## Autorest Typescript Plugin Configuration
|
|
54
54
|
|
|
55
55
|
```yaml
|
|
56
|
-
version: 3.
|
|
56
|
+
version: 3.6.6
|
|
57
57
|
use-extension:
|
|
58
|
-
"@autorest/modelerfour": "4.
|
|
58
|
+
"@autorest/modelerfour": "4.23.5"
|
|
59
59
|
|
|
60
60
|
modelerfour:
|
|
61
61
|
# this runs a pre-namer step to clean up names
|
|
@@ -68,7 +68,17 @@ modelerfour:
|
|
|
68
68
|
always-create-content-type-parameter: true
|
|
69
69
|
# enables parameter grouping via x-ms-parameter-grouping
|
|
70
70
|
group-parameters: true
|
|
71
|
+
# Enable older inconsistent behavior that an enum with a single value would become a constant by default.
|
|
72
|
+
seal-single-value-enum-by-default: true
|
|
73
|
+
legacy-request-body: true
|
|
71
74
|
|
|
75
|
+
typescript-scope/emitter:
|
|
76
|
+
input-artifact: typescript-files
|
|
77
|
+
|
|
78
|
+
output-artifact: typescript-files
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
```yaml !$(generate-sample)
|
|
72
82
|
pipeline:
|
|
73
83
|
typescript: # <- name of plugin
|
|
74
84
|
input: modelerfour/identity
|
|
@@ -78,10 +88,37 @@ pipeline:
|
|
|
78
88
|
input: typescript
|
|
79
89
|
scope: typescript-scope/emitter
|
|
80
90
|
|
|
81
|
-
|
|
82
|
-
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
```yaml $(generate-sample)
|
|
94
|
+
use-extension:
|
|
95
|
+
"@autorest/testmodeler": "2.2.5"
|
|
96
|
+
|
|
97
|
+
try-require:
|
|
98
|
+
- ./readme.test.md
|
|
99
|
+
- ./readme.tests.md
|
|
100
|
+
|
|
101
|
+
testmodeler:
|
|
102
|
+
split-parents-value: false
|
|
103
|
+
|
|
104
|
+
include-x-ms-examples-original-file: true
|
|
105
|
+
modelerfour:
|
|
106
|
+
include-x-ms-examples-original-file: true
|
|
107
|
+
|
|
108
|
+
pipeline:
|
|
109
|
+
test-modeler:
|
|
110
|
+
input: modelerfour/identity
|
|
111
|
+
# scope : output-scope
|
|
112
|
+
test-modeler/identity:
|
|
113
|
+
input: test-modeler
|
|
114
|
+
typescript:
|
|
115
|
+
input: test-modeler/identity
|
|
116
|
+
output-artifact: typescript-files
|
|
117
|
+
|
|
118
|
+
typescript/emitter:
|
|
119
|
+
input: typescript
|
|
120
|
+
scope: typescript-scope/emitter
|
|
83
121
|
|
|
84
|
-
output-artifact: typescript-files
|
|
85
122
|
```
|
|
86
123
|
|
|
87
124
|
### REST Client Generator overrides
|
|
@@ -24,6 +24,8 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f
|
|
|
24
24
|
- [LTS versions of Node.js](https://nodejs.org/about/releases/)
|
|
25
25
|
- Latest versions of Safari, Chrome, Edge and Firefox.
|
|
26
26
|
|
|
27
|
+
See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
|
|
28
|
+
|
|
27
29
|
{{#if azure}}
|
|
28
30
|
### Prerequisites
|
|
29
31
|
|
|
@@ -47,9 +49,9 @@ npm install {{ clientPackageName }}
|
|
|
47
49
|
To create a client object to access the {{ serviceName }} API, you will need the `endpoint` of your {{ serviceName }} resource and a `credential`. The {{ clientDescriptiveName }} can use Azure Active Directory credentials to authenticate.
|
|
48
50
|
You can find the endpoint for your {{ serviceName }} resource in the [Azure Portal][azure_portal].
|
|
49
51
|
|
|
50
|
-
|
|
52
|
+
You can authenticate with Azure Active Directory using a credential from the [@azure/identity][azure_identity] library or [an existing AAD Token](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token).
|
|
51
53
|
|
|
52
|
-
|
|
54
|
+
To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package:
|
|
53
55
|
|
|
54
56
|
```bash
|
|
55
57
|
npm install @azure/identity
|
|
@@ -60,12 +62,42 @@ Set the values of the client ID, tenant ID, and client secret of the AAD applica
|
|
|
60
62
|
|
|
61
63
|
For more information about how to create an Azure AD Application check out [this guide](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
|
|
62
64
|
|
|
65
|
+
{{#if azureArm}}
|
|
63
66
|
```javascript
|
|
64
67
|
const { {{ clientClassName }} } = require("{{ clientPackageName }}");
|
|
65
68
|
const { DefaultAzureCredential } = require("@azure/identity");
|
|
69
|
+
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.
|
|
70
|
+
|
|
71
|
+
const subscriptionId = "00000000-0000-0000-0000-000000000000";
|
|
72
|
+
const client = new {{ clientClassName }}(new DefaultAzureCredential(), subscriptionId);
|
|
73
|
+
|
|
74
|
+
// For client-side applications running in the browser, use this code instead:
|
|
75
|
+
// const credential = new InteractiveBrowserCredential({
|
|
76
|
+
// tenantId: "<YOUR_TENANT_ID>",
|
|
77
|
+
// clientId: "<YOUR_CLIENT_ID>"
|
|
78
|
+
// });
|
|
79
|
+
// const client = new {{ clientClassName }}(credential, subscriptionId);
|
|
80
|
+
```
|
|
81
|
+
{{else}}
|
|
82
|
+
```javascript
|
|
83
|
+
const { {{ clientClassName }} } = require("{{ clientPackageName }}");
|
|
84
|
+
const { DefaultAzureCredential } = require("@azure/identity");
|
|
85
|
+
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.
|
|
86
|
+
|
|
66
87
|
const client = new {{ clientClassName }}("<endpoint>", new DefaultAzureCredential());
|
|
88
|
+
// For client-side applications running in the browser, use this code instead:
|
|
89
|
+
// const credential = new InteractiveBrowserCredential({
|
|
90
|
+
// tenantId: "<YOUR_TENANT_ID>",
|
|
91
|
+
// clientId: "<YOUR_CLIENT_ID>"
|
|
92
|
+
// });
|
|
93
|
+
// const client = new {{ clientClassName }}("<endpoint>", credential);
|
|
67
94
|
```
|
|
95
|
+
{{/if}}
|
|
68
96
|
{{/if}}{{/if}}
|
|
97
|
+
|
|
98
|
+
### JavaScript Bundle
|
|
99
|
+
To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling).
|
|
100
|
+
|
|
69
101
|
## Key concepts
|
|
70
102
|
|
|
71
103
|
### {{ clientClassName }}
|
|
@@ -80,7 +112,7 @@ const client = new {{ clientClassName }}("<endpoint>", new DefaultAzureCredentia
|
|
|
80
112
|
Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
|
|
81
113
|
|
|
82
114
|
```javascript
|
|
83
|
-
|
|
115
|
+
const { setLogLevel } = require("@azure/logger");
|
|
84
116
|
setLogLevel("info");
|
|
85
117
|
```
|
|
86
118
|
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
|
|
2
|
+
// Copyright (c) Microsoft Corporation.
|
|
3
|
+
// Licensed under the MIT License.
|
|
4
|
+
import {
|
|
5
|
+
{{#if importedTypes.length }}
|
|
6
|
+
{{#each importedTypes}}
|
|
7
|
+
{{this}},
|
|
8
|
+
{{/each}}
|
|
9
|
+
{{/if}}
|
|
10
|
+
{{clientClassName}},
|
|
11
|
+
} from "{{clientPackageName}}";
|
|
12
|
+
import { DefaultAzureCredential } from "@azure/identity";
|
|
13
|
+
|
|
14
|
+
{{#each samples}}
|
|
15
|
+
/**
|
|
16
|
+
* This sample demonstrates how to {{this.operationDescription}}
|
|
17
|
+
*
|
|
18
|
+
* @summary {{this.operationDescription}}
|
|
19
|
+
* x-ms-original-file: {{this.originalFileLocation}}
|
|
20
|
+
*/
|
|
21
|
+
async function {{this.sampleFunctionName}}() {
|
|
22
|
+
{{#each this.clientParamAssignments}}
|
|
23
|
+
{{this}}
|
|
24
|
+
{{/each}}
|
|
25
|
+
{{#each this.methodParamAssignments}}
|
|
26
|
+
{{this}}
|
|
27
|
+
{{/each}}
|
|
28
|
+
const credential = new DefaultAzureCredential();
|
|
29
|
+
const client = new {{this.clientClassName}}({{this.clientParameterNames}});
|
|
30
|
+
{{#if this.isPaging}}
|
|
31
|
+
const resArray = new Array();
|
|
32
|
+
for await (let item of client{{#unless this.isTopLevel}}.{{this.operationGroupName}}{{/unless}}.{{this.operationName}}({{this.methodParameterNames}})){
|
|
33
|
+
resArray.push(item);
|
|
34
|
+
}
|
|
35
|
+
console.log(resArray);
|
|
36
|
+
{{else}}
|
|
37
|
+
const result = await client
|
|
38
|
+
{{#unless this.isTopLevel}}
|
|
39
|
+
.{{this.operationGroupName}}
|
|
40
|
+
{{/unless}}
|
|
41
|
+
.{{this.operationName}}({{this.methodParameterNames}});
|
|
42
|
+
console.log(result);
|
|
43
|
+
|
|
44
|
+
{{/if}}
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
{{this.sampleFunctionName}}().catch(console.error);
|
|
48
|
+
|
|
49
|
+
{{/each}}
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
// https://github.com/karma-runner/karma-chrome-launcher
|
|
2
|
+
process.env.CHROME_BIN = require("puppeteer").executablePath();
|
|
3
|
+
require("dotenv").config();
|
|
4
|
+
const { relativeRecordingsPath } = require("@azure-tools/test-recorder");
|
|
5
|
+
process.env.RECORDINGS_RELATIVE_PATH = relativeRecordingsPath();
|
|
6
|
+
|
|
7
|
+
module.exports = function (config) {
|
|
8
|
+
config.set({
|
|
9
|
+
// base path that will be used to resolve all patterns (eg. files, exclude)
|
|
10
|
+
basePath: "./",
|
|
11
|
+
|
|
12
|
+
// frameworks to use
|
|
13
|
+
// available frameworks: https://npmjs.org/browse/keyword/karma-adapter
|
|
14
|
+
frameworks: ["source-map-support", "mocha"],
|
|
15
|
+
|
|
16
|
+
plugins: [
|
|
17
|
+
"karma-mocha",
|
|
18
|
+
"karma-mocha-reporter",
|
|
19
|
+
"karma-chrome-launcher",
|
|
20
|
+
"karma-edge-launcher",
|
|
21
|
+
"karma-firefox-launcher",
|
|
22
|
+
"karma-ie-launcher",
|
|
23
|
+
"karma-env-preprocessor",
|
|
24
|
+
"karma-coverage",
|
|
25
|
+
"karma-sourcemap-loader",
|
|
26
|
+
"karma-junit-reporter",
|
|
27
|
+
"karma-source-map-support",
|
|
28
|
+
],
|
|
29
|
+
|
|
30
|
+
// list of files / patterns to load in the browser
|
|
31
|
+
files: [
|
|
32
|
+
"dist-test/index.browser.js",
|
|
33
|
+
{ pattern: "dist-test/index.browser.js.map", type: "html", included: false, served: true },
|
|
34
|
+
],
|
|
35
|
+
|
|
36
|
+
// list of files / patterns to exclude
|
|
37
|
+
exclude: [],
|
|
38
|
+
|
|
39
|
+
// preprocess matching files before serving them to the browser
|
|
40
|
+
// available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
|
|
41
|
+
preprocessors: {
|
|
42
|
+
"**/*.js": ["sourcemap", "env"],
|
|
43
|
+
// IMPORTANT: COMMENT following line if you want to debug in your browsers!!
|
|
44
|
+
// Preprocess source file to calculate code coverage, however this will make source file unreadable
|
|
45
|
+
// "dist-test/index.js": ["coverage"]
|
|
46
|
+
},
|
|
47
|
+
|
|
48
|
+
envPreprocessor: [
|
|
49
|
+
"TEST_MODE",
|
|
50
|
+
"ENDPOINT",
|
|
51
|
+
"AZURE_CLIENT_SECRET",
|
|
52
|
+
"AZURE_CLIENT_ID",
|
|
53
|
+
"AZURE_TENANT_ID",
|
|
54
|
+
"SUBSCRIPTION_ID",
|
|
55
|
+
],
|
|
56
|
+
|
|
57
|
+
// test results reporter to use
|
|
58
|
+
// possible values: 'dots', 'progress'
|
|
59
|
+
// available reporters: https://npmjs.org/browse/keyword/karma-reporter
|
|
60
|
+
reporters: ["mocha", "coverage", "junit"],
|
|
61
|
+
|
|
62
|
+
coverageReporter: {
|
|
63
|
+
// specify a common output directory
|
|
64
|
+
dir: "coverage-browser/",
|
|
65
|
+
reporters: [
|
|
66
|
+
{ type: "json", subdir: ".", file: "coverage.json" },
|
|
67
|
+
{ type: "lcovonly", subdir: ".", file: "lcov.info" },
|
|
68
|
+
{ type: "html", subdir: "html" },
|
|
69
|
+
{ type: "cobertura", subdir: ".", file: "cobertura-coverage.xml" },
|
|
70
|
+
],
|
|
71
|
+
},
|
|
72
|
+
|
|
73
|
+
junitReporter: {
|
|
74
|
+
outputDir: "", // results will be saved as $outputDir/$browserName.xml
|
|
75
|
+
outputFile: "test-results.browser.xml", // if included, results will be saved as $outputDir/$browserName/$outputFile
|
|
76
|
+
suite: "", // suite will become the package name attribute in xml testsuite element
|
|
77
|
+
useBrowserName: false, // add browser name to report and classes names
|
|
78
|
+
nameFormatter: undefined, // function (browser, result) to customize the name attribute in xml testcase element
|
|
79
|
+
classNameFormatter: undefined, // function (browser, result) to customize the classname attribute in xml testcase element
|
|
80
|
+
properties: {}, // key value pair of properties to add to the <properties> section of the report
|
|
81
|
+
},
|
|
82
|
+
|
|
83
|
+
// web server port
|
|
84
|
+
port: 9876,
|
|
85
|
+
|
|
86
|
+
// enable / disable colors in the output (reporters and logs)
|
|
87
|
+
colors: true,
|
|
88
|
+
|
|
89
|
+
// level of logging
|
|
90
|
+
// possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
|
|
91
|
+
logLevel: config.LOG_INFO,
|
|
92
|
+
|
|
93
|
+
// enable / disable watching file and executing tests whenever any file changes
|
|
94
|
+
autoWatch: false,
|
|
95
|
+
|
|
96
|
+
// --no-sandbox allows our tests to run in Linux without having to change the system.
|
|
97
|
+
// --disable-web-security allows us to authenticate from the browser without having to write tests using interactive auth, which would be far more complex.
|
|
98
|
+
browsers: ["ChromeHeadlessNoSandbox"],
|
|
99
|
+
customLaunchers: {
|
|
100
|
+
ChromeHeadlessNoSandbox: {
|
|
101
|
+
base: "ChromeHeadless",
|
|
102
|
+
flags: ["--no-sandbox", "--disable-web-security"],
|
|
103
|
+
},
|
|
104
|
+
},
|
|
105
|
+
|
|
106
|
+
// Continuous Integration mode
|
|
107
|
+
// if true, Karma captures browsers, runs the tests and exits
|
|
108
|
+
singleRun: false,
|
|
109
|
+
|
|
110
|
+
// Concurrency level
|
|
111
|
+
// how many browser should be started simultaneous
|
|
112
|
+
concurrency: 1,
|
|
113
|
+
|
|
114
|
+
browserNoActivityTimeout: 60000000,
|
|
115
|
+
browserDisconnectTimeout: 10000,
|
|
116
|
+
browserDisconnectTolerance: 3,
|
|
117
|
+
|
|
118
|
+
client: {
|
|
119
|
+
mocha: {
|
|
120
|
+
// change Karma's debug.html to the mocha web reporter
|
|
121
|
+
reporter: "html",
|
|
122
|
+
timeout: "600000",
|
|
123
|
+
},
|
|
124
|
+
},
|
|
125
|
+
});
|
|
126
|
+
};
|
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
import {
|
|
2
|
+
getPagedAsyncIterator,
|
|
3
|
+
PagedAsyncIterableIterator,
|
|
4
|
+
PagedResult
|
|
5
|
+
} from "@azure/core-paging";
|
|
6
|
+
import {
|
|
7
|
+
Client,
|
|
8
|
+
createRestError,
|
|
9
|
+
PathUncheckedResponse
|
|
10
|
+
} from "@azure-rest/core-client";
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* Helper type to extract the type of an array
|
|
14
|
+
*/
|
|
15
|
+
export type GetArrayType<T> = T extends Array<infer TData> ? TData : never;
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* The type of a custom function that defines how to get a page and a link to the next one if any.
|
|
19
|
+
*/
|
|
20
|
+
export type GetPage<TPage> = (
|
|
21
|
+
pageLink: string,
|
|
22
|
+
maxPageSize?: number
|
|
23
|
+
) => Promise<{
|
|
24
|
+
page: TPage;
|
|
25
|
+
nextPageLink?: string;
|
|
26
|
+
}>;
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* Options for the paging helper
|
|
30
|
+
*/
|
|
31
|
+
export interface PagingOptions<TResponse> {
|
|
32
|
+
/**
|
|
33
|
+
* Custom function to extract pagination details for crating the PagedAsyncIterableIterator
|
|
34
|
+
*/
|
|
35
|
+
customGetPage?: GetPage<PaginateReturn<TResponse>[]>
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* Helper type to infer the Type of the paged elements from the response type
|
|
40
|
+
* This type is generated based on the swagger information for x-ms-pageable
|
|
41
|
+
* specifically on the itemName property which indicates the property of the response
|
|
42
|
+
* where the page items are found. The default value is `value`.
|
|
43
|
+
* This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
|
|
44
|
+
*/
|
|
45
|
+
export type PaginateReturn<TResult> = TResult extends {{#each itemNames}}
|
|
46
|
+
{
|
|
47
|
+
|
|
48
|
+
body: { {{this}}?: infer TPage }
|
|
49
|
+
|
|
50
|
+
} {{#if @last }}{{else}} | {{/if}}
|
|
51
|
+
{{/each}}
|
|
52
|
+
? GetArrayType<TPage>
|
|
53
|
+
: Array<unknown>;
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension
|
|
57
|
+
* @param client - Client to use for sending the next page requests
|
|
58
|
+
* @param initialResponse - Initial response containing the nextLink and current page of elements
|
|
59
|
+
* @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results
|
|
60
|
+
* @returns - PagedAsyncIterableIterator to iterate the elements
|
|
61
|
+
*/
|
|
62
|
+
export function paginate<TResponse extends PathUncheckedResponse>(
|
|
63
|
+
client: Client,
|
|
64
|
+
initialResponse: TResponse,
|
|
65
|
+
options: PagingOptions<TResponse> = {}
|
|
66
|
+
): PagedAsyncIterableIterator<PaginateReturn<TResponse>> {
|
|
67
|
+
// Extract element type from initial response
|
|
68
|
+
type TElement = PaginateReturn<TResponse>;
|
|
69
|
+
let firstRun = true;
|
|
70
|
+
{{#if isComplexPaging}}
|
|
71
|
+
// We need to check the response for success before trying to inspect it looking for
|
|
72
|
+
// the properties to use for nextLink and itemName
|
|
73
|
+
checkPagingRequest(initialResponse);
|
|
74
|
+
const { itemName, nextLinkName } = getPaginationProperties(initialResponse);
|
|
75
|
+
{{else}}
|
|
76
|
+
const itemName = {{ quoteWrap itemNames }};
|
|
77
|
+
const nextLinkName = {{quoteWrap nextLinkNames}};
|
|
78
|
+
{{/if}}
|
|
79
|
+
const { customGetPage } = options;
|
|
80
|
+
const pagedResult: PagedResult<TElement[]> = {
|
|
81
|
+
firstPageLink: "",
|
|
82
|
+
getPage:
|
|
83
|
+
typeof customGetPage === "function"
|
|
84
|
+
? customGetPage
|
|
85
|
+
: async (pageLink: string) => {
|
|
86
|
+
const result = firstRun
|
|
87
|
+
? initialResponse
|
|
88
|
+
: await client.pathUnchecked(pageLink).get();
|
|
89
|
+
firstRun = false;
|
|
90
|
+
checkPagingRequest(result);
|
|
91
|
+
const nextLink = getNextLink(result.body, nextLinkName);
|
|
92
|
+
const values = getElements<TElement>(result.body, itemName);
|
|
93
|
+
return {
|
|
94
|
+
page: values,
|
|
95
|
+
nextPageLink: nextLink
|
|
96
|
+
};
|
|
97
|
+
}
|
|
98
|
+
};
|
|
99
|
+
|
|
100
|
+
return getPagedAsyncIterator(pagedResult);
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
/**
|
|
104
|
+
* Gets for the value of nextLink in the body
|
|
105
|
+
*/
|
|
106
|
+
function getNextLink(body: unknown, nextLinkName?: string): string | undefined {
|
|
107
|
+
if (!nextLinkName) {
|
|
108
|
+
return undefined;
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
const nextLink = (body as Record<string, unknown>)[nextLinkName];
|
|
112
|
+
|
|
113
|
+
if (typeof nextLink !== "string" && typeof nextLink !== "undefined") {
|
|
114
|
+
throw new Error(
|
|
115
|
+
`Body Property ${nextLinkName} should be a string or undefined`
|
|
116
|
+
);
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
return nextLink;
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
/**
|
|
123
|
+
* Gets the elements of the current request in the body.
|
|
124
|
+
*/
|
|
125
|
+
function getElements<T = unknown>(body: unknown, itemName: string): T[] {
|
|
126
|
+
const value = (body as Record<string, unknown>)[itemName] as T[];
|
|
127
|
+
|
|
128
|
+
// value has to be an array according to the x-ms-pageable extension.
|
|
129
|
+
// The fact that this must be an array is used above to calculate the
|
|
130
|
+
// type of elements in the page in PaginateReturn
|
|
131
|
+
if (!Array.isArray(value)) {
|
|
132
|
+
throw new Error(
|
|
133
|
+
`Couldn't paginate response\n Body doesn't contain an array property with name: ${itemName}`
|
|
134
|
+
);
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
return value ?? [];
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
/**
|
|
141
|
+
* Checks if a request failed
|
|
142
|
+
*/
|
|
143
|
+
function checkPagingRequest(response: PathUncheckedResponse): void {
|
|
144
|
+
const Http2xxStatusCodes = [
|
|
145
|
+
"200",
|
|
146
|
+
"201",
|
|
147
|
+
"202",
|
|
148
|
+
"203",
|
|
149
|
+
"204",
|
|
150
|
+
"205",
|
|
151
|
+
"206",
|
|
152
|
+
"207",
|
|
153
|
+
"208",
|
|
154
|
+
"226"
|
|
155
|
+
];
|
|
156
|
+
if (!Http2xxStatusCodes.includes(response.status)) {
|
|
157
|
+
throw createRestError(
|
|
158
|
+
`Pagination failed with unexpected statusCode ${response.status}`,
|
|
159
|
+
response
|
|
160
|
+
);
|
|
161
|
+
}
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
{{#if isComplexPaging}}
|
|
165
|
+
/**
|
|
166
|
+
* Extracts the itemName and nextLinkName from the initial response to use them for pagination
|
|
167
|
+
*/
|
|
168
|
+
function getPaginationProperties(initialResponse: PathUncheckedResponse) {
|
|
169
|
+
// Build a set with the passed custom nextLinkNames
|
|
170
|
+
const nextLinkNames = new Set([{{ quoteWrap nextLinkNames }}]);
|
|
171
|
+
|
|
172
|
+
// Build a set with the passed custom set of itemNames
|
|
173
|
+
const itemNames = new Set([{{ quoteWrap itemNames }}]);
|
|
174
|
+
|
|
175
|
+
let nextLinkName: string | undefined;
|
|
176
|
+
let itemName: string | undefined;
|
|
177
|
+
|
|
178
|
+
for (const name of nextLinkNames) {
|
|
179
|
+
const nextLink = (initialResponse.body as Record<string, unknown>)[
|
|
180
|
+
name
|
|
181
|
+
] as string;
|
|
182
|
+
if (nextLink) {
|
|
183
|
+
nextLinkName = name;
|
|
184
|
+
break;
|
|
185
|
+
}
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
for (const name of itemNames) {
|
|
189
|
+
const item = (initialResponse.body as Record<string, unknown>)[
|
|
190
|
+
name
|
|
191
|
+
] as string;
|
|
192
|
+
if (item) {
|
|
193
|
+
itemName = name;
|
|
194
|
+
break;
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
if (!itemName) {
|
|
199
|
+
throw new Error(
|
|
200
|
+
`Couldn't paginate response\n Body doesn't contain an array property with name: ${[
|
|
201
|
+
...itemNames
|
|
202
|
+
].join(" OR ")}`
|
|
203
|
+
);
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
return { itemName, nextLinkName };
|
|
207
|
+
}
|
|
208
|
+
{{/if}}
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import { Client, HttpResponse } from "@azure-rest/core-client";
|
|
2
|
+
import {
|
|
3
|
+
LongRunningOperation,
|
|
4
|
+
LroEngine,
|
|
5
|
+
LroEngineOptions,
|
|
6
|
+
LroResponse,
|
|
7
|
+
PollerLike,
|
|
8
|
+
PollOperationState
|
|
9
|
+
} from "@azure/core-lro";
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* Helper function that builds a Poller object to help polling a long running operation.
|
|
13
|
+
* @param client - Client to use for sending the request to get additional pages.
|
|
14
|
+
* @param initialResponse - The initial response.
|
|
15
|
+
* @param options - Options to set a resume state or custom polling interval.
|
|
16
|
+
* @returns - A poller object to poll for operation state updates and eventually get the final response.
|
|
17
|
+
*/
|
|
18
|
+
export function getLongRunningPoller<TResult extends HttpResponse>(
|
|
19
|
+
client: Client,
|
|
20
|
+
initialResponse: TResult,
|
|
21
|
+
options: LroEngineOptions<TResult, PollOperationState<TResult>> = {}
|
|
22
|
+
): PollerLike<PollOperationState<TResult>, TResult> {
|
|
23
|
+
const poller: LongRunningOperation<TResult> = {
|
|
24
|
+
requestMethod: initialResponse.request.method,
|
|
25
|
+
requestPath: initialResponse.request.url,
|
|
26
|
+
sendInitialRequest: async () => {
|
|
27
|
+
// In the case of Rest Clients we are building the LRO poller object from a response that's the reason
|
|
28
|
+
// we are not triggering the initial request here, just extracting the information from the
|
|
29
|
+
// response we were provided.
|
|
30
|
+
return getLroResponse(initialResponse);
|
|
31
|
+
},
|
|
32
|
+
sendPollRequest: async path => {
|
|
33
|
+
// This is the callback that is going to be called to poll the service
|
|
34
|
+
// to get the latest status. We use the client provided and the polling path
|
|
35
|
+
// which is an opaque URL provided by caller, the service sends this in one of the following headers: operation-location, azure-asyncoperation or location
|
|
36
|
+
// depending on the lro pattern that the service implements. If non is provided we default to the initial path.
|
|
37
|
+
const response = await client
|
|
38
|
+
.pathUnchecked(path ?? initialResponse.request.url)
|
|
39
|
+
.get();
|
|
40
|
+
const lroResponse = getLroResponse(response as TResult);
|
|
41
|
+
lroResponse.rawResponse.headers["x-ms-original-url"] =
|
|
42
|
+
initialResponse.request.url;
|
|
43
|
+
return lroResponse;
|
|
44
|
+
}
|
|
45
|
+
};
|
|
46
|
+
|
|
47
|
+
return new LroEngine(poller, options);
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Converts a Rest Client response to a response that the LRO engine knows about
|
|
52
|
+
* @param response - a rest client http response
|
|
53
|
+
* @returns - An LRO response that the LRO engine can work with
|
|
54
|
+
*/
|
|
55
|
+
function getLroResponse<TResult extends HttpResponse>(
|
|
56
|
+
response: TResult
|
|
57
|
+
): LroResponse<TResult> {
|
|
58
|
+
if (Number.isNaN(response.status)) {
|
|
59
|
+
throw new TypeError(
|
|
60
|
+
`Status code of the response is not a number. Value: ${response.status}`
|
|
61
|
+
);
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
return {
|
|
65
|
+
flatResponse: response,
|
|
66
|
+
rawResponse: {
|
|
67
|
+
...response,
|
|
68
|
+
statusCode: Number.parseInt(response.status),
|
|
69
|
+
body: response.body
|
|
70
|
+
}
|
|
71
|
+
};
|
|
72
|
+
}
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# {{ clientDescriptiveName }} library for JavaScript
|
|
2
|
+
|
|
3
|
+
{{ description }}
|
|
4
|
+
|
|
5
|
+
**Please rely heavily on {{#if serviceDocURL}}[the service's documentation]({{ serviceDocURL }}) and {{/if}}our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library**
|
|
6
|
+
|
|
7
|
+
Key links:
|
|
8
|
+
|
|
9
|
+
{{#if packageSourceURL}}
|
|
10
|
+
- [Source code]({{ packageSourceURL }})
|
|
11
|
+
{{/if}}
|
|
12
|
+
{{#if packageNPMURL}}
|
|
13
|
+
- [Package (NPM)]({{ packageNPMURL }})
|
|
14
|
+
{{/if}}
|
|
15
|
+
{{#if apiRefURL}}
|
|
16
|
+
- [API reference documentation]({{ apiRefURL }})
|
|
17
|
+
{{/if}}
|
|
18
|
+
{{#if serviceDocURL}}
|
|
19
|
+
- [Product documentation]({{ serviceDocURL }})
|
|
20
|
+
{{/if}}
|
|
21
|
+
{{#if samplesURL}}
|
|
22
|
+
- [Samples]({{ samplesURL }})
|
|
23
|
+
{{/if}}
|
|
24
|
+
|
|
25
|
+
## Getting started
|
|
26
|
+
|
|
27
|
+
### Currently supported environments
|
|
28
|
+
|
|
29
|
+
- Node.js version 14.x.x or higher
|
|
30
|
+
|
|
31
|
+
### Prerequisites
|
|
32
|
+
|
|
33
|
+
- You must have an [Azure subscription](https://azure.microsoft.com/free/){{#if dependencyLink}} and follow [these]({{ dependencyLink }}) instructions{{/if}} to use this package.
|
|
34
|
+
|
|
35
|
+
### Install the `{{ clientPackageName }}` package
|
|
36
|
+
|
|
37
|
+
Install the {{ clientDescriptiveName }} REST client library for JavaScript with `npm`:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npm install {{ clientPackageName }}
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Create and authenticate a `{{ clientClassName }}`
|
|
44
|
+
|
|
45
|
+
To use an [Azure Active Directory (AAD) token credential](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token),
|
|
46
|
+
provide an instance of the desired credential type obtained from the
|
|
47
|
+
[@azure/identity](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) library.
|
|
48
|
+
|
|
49
|
+
To authenticate with AAD, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) {{#if dependencyLink}}and
|
|
50
|
+
[{{dependencyDescription }}]({{ dependencyLink }}){{/if}}
|
|
51
|
+
|
|
52
|
+
After setup, you can choose which type of [credential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) from `@azure/identity` to use.
|
|
53
|
+
As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential)
|
|
54
|
+
can be used to authenticate the client.
|
|
55
|
+
|
|
56
|
+
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
|
|
57
|
+
AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
|
|
58
|
+
|
|
59
|
+
## Troubleshooting
|
|
60
|
+
|
|
61
|
+
### Logging
|
|
62
|
+
|
|
63
|
+
Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
|
|
64
|
+
|
|
65
|
+
```javascript
|
|
66
|
+
import { setLogLevel } from "@azure/logger";
|
|
67
|
+
|
|
68
|
+
setLogLevel("info");
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
|