@voxgig/sdkgen 0.35.1 → 0.36.0
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/bin/voxgig-sdkgen +1 -1
- package/dist/cmp/Readme.js +5 -5
- package/dist/cmp/Readme.js.map +1 -1
- package/dist/cmp/ReadmeEntity.js +74 -24
- package/dist/cmp/ReadmeEntity.js.map +1 -1
- package/dist/cmp/ReadmeExplanation.d.ts +2 -0
- package/dist/cmp/ReadmeExplanation.js +308 -0
- package/dist/cmp/ReadmeExplanation.js.map +1 -0
- package/dist/cmp/ReadmeHowto.d.ts +2 -0
- package/dist/cmp/ReadmeHowto.js +18 -0
- package/dist/cmp/ReadmeHowto.js.map +1 -0
- package/dist/cmp/ReadmeIntro.js +8 -23
- package/dist/cmp/ReadmeIntro.js.map +1 -1
- package/dist/cmp/ReadmeModel.js +55 -91
- package/dist/cmp/ReadmeModel.js.map +1 -1
- package/dist/cmp/ReadmeOptions.js +35 -11
- package/dist/cmp/ReadmeOptions.js.map +1 -1
- package/dist/cmp/ReadmeQuick.js +4 -1
- package/dist/cmp/ReadmeQuick.js.map +1 -1
- package/dist/cmp/ReadmeRef.js +1042 -40
- package/dist/cmp/ReadmeRef.js.map +1 -1
- package/dist/cmp/ReadmeTop.d.ts +2 -0
- package/dist/cmp/ReadmeTop.js +171 -0
- package/dist/cmp/ReadmeTop.js.map +1 -0
- package/dist/sdkgen.d.ts +7 -1
- package/dist/sdkgen.js +13 -1
- package/dist/sdkgen.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +2 -2
- package/project/.sdk/model/feature/feature-index.jsonic +5 -0
- package/project/.sdk/model/feature/log.jsonic +5 -1
- package/project/.sdk/model/feature/test.jsonic +1 -1
- package/project/.sdk/model/target/lua.jsonic +23 -0
- package/project/.sdk/model/target/php.jsonic +22 -0
- package/project/.sdk/model/target/py.jsonic +23 -0
- package/project/.sdk/model/target/rb.jsonic +23 -0
- package/project/.sdk/src/cmp/go/Main_go.ts +2 -6
- package/project/.sdk/src/cmp/go/ReadmeExplanation_go.ts +42 -0
- package/project/.sdk/src/cmp/go/ReadmeHowto_go.ts +112 -0
- package/project/.sdk/src/cmp/go/ReadmeInstall_go.ts +29 -0
- package/project/.sdk/src/cmp/go/ReadmeModel_go.ts +129 -0
- package/project/.sdk/src/cmp/go/ReadmeQuick_go.ts +163 -0
- package/project/.sdk/src/cmp/go/ReadmeTopHowto_go.ts +24 -0
- package/project/.sdk/src/cmp/go/ReadmeTopQuick_go.ts +67 -0
- package/project/.sdk/src/cmp/go/ReadmeTopTest_go.ts +40 -0
- package/project/.sdk/src/cmp/go/TestDirect_go.ts +46 -2
- package/project/.sdk/src/cmp/go/TestEntity_go.ts +360 -160
- package/project/.sdk/src/cmp/go/Test_go.ts +24 -1
- package/project/.sdk/src/cmp/js/ReadmeQuick_js.ts +1 -1
- package/project/.sdk/src/cmp/js/fragment/Main.fragment.js +0 -4
- package/project/.sdk/src/cmp/lua/Config_lua.ts +112 -0
- package/project/.sdk/src/cmp/lua/EntityOperation_lua.ts +44 -0
- package/project/.sdk/src/cmp/lua/Entity_lua.ts +62 -0
- package/project/.sdk/src/cmp/lua/MainEntity_lua.ts +23 -0
- package/project/.sdk/src/cmp/lua/Main_lua.ts +133 -0
- package/project/.sdk/src/cmp/lua/Package_lua.ts +80 -0
- package/project/.sdk/src/cmp/lua/ReadmeExplanation_lua.ts +42 -0
- package/project/.sdk/src/cmp/lua/ReadmeHowto_lua.ts +100 -0
- package/project/.sdk/src/cmp/lua/ReadmeInstall_lua.ts +26 -0
- package/project/.sdk/src/cmp/lua/ReadmeModel_lua.ts +129 -0
- package/project/.sdk/src/cmp/lua/ReadmeQuick_lua.ts +99 -0
- package/project/.sdk/src/cmp/lua/ReadmeTopHowto_lua.ts +24 -0
- package/project/.sdk/src/cmp/lua/ReadmeTopQuick_lua.ts +55 -0
- package/project/.sdk/src/cmp/lua/ReadmeTopTest_lua.ts +38 -0
- package/project/.sdk/src/cmp/lua/TestDirect_lua.ts +261 -0
- package/project/.sdk/src/cmp/lua/TestEntity_lua.ts +483 -0
- package/project/.sdk/src/cmp/lua/Test_lua.ts +49 -0
- package/project/.sdk/src/cmp/lua/fragment/Entity.fragment.lua +147 -0
- package/project/.sdk/src/cmp/lua/fragment/EntityCreateOp.fragment.lua +27 -0
- package/project/.sdk/src/cmp/lua/fragment/EntityListOp.fragment.lua +24 -0
- package/project/.sdk/src/cmp/lua/fragment/EntityLoadOp.fragment.lua +30 -0
- package/project/.sdk/src/cmp/lua/fragment/EntityRemoveOp.fragment.lua +30 -0
- package/project/.sdk/src/cmp/lua/fragment/EntityUpdateOp.fragment.lua +30 -0
- package/project/.sdk/src/cmp/lua/fragment/Main.fragment.lua +256 -0
- package/project/.sdk/src/cmp/lua/fragment/SdkError.fragment.lua +26 -0
- package/project/.sdk/src/cmp/lua/tsconfig.json +15 -0
- package/project/.sdk/src/cmp/lua/utility_lua.ts +84 -0
- package/project/.sdk/src/cmp/php/Config_php.ts +107 -0
- package/project/.sdk/src/cmp/php/EntityOperation_php.ts +44 -0
- package/project/.sdk/src/cmp/php/Entity_php.ts +62 -0
- package/project/.sdk/src/cmp/php/MainEntity_php.ts +24 -0
- package/project/.sdk/src/cmp/php/Main_php.ts +135 -0
- package/project/.sdk/src/cmp/php/Package_php.ts +87 -0
- package/project/.sdk/src/cmp/php/ReadmeExplanation_php.ts +42 -0
- package/project/.sdk/src/cmp/php/ReadmeHowto_php.ts +101 -0
- package/project/.sdk/src/cmp/php/ReadmeInstall_php.ts +19 -0
- package/project/.sdk/src/cmp/php/ReadmeModel_php.ts +129 -0
- package/project/.sdk/src/cmp/php/ReadmeQuick_php.ts +100 -0
- package/project/.sdk/src/cmp/php/ReadmeTopHowto_php.ts +24 -0
- package/project/.sdk/src/cmp/php/ReadmeTopQuick_php.ts +56 -0
- package/project/.sdk/src/cmp/php/ReadmeTopTest_php.ts +38 -0
- package/project/.sdk/src/cmp/php/TestDirect_php.ts +270 -0
- package/project/.sdk/src/cmp/php/TestEntity_php.ts +484 -0
- package/project/.sdk/src/cmp/php/Test_php.ts +56 -0
- package/project/.sdk/src/cmp/php/fragment/Entity.fragment.php +146 -0
- package/project/.sdk/src/cmp/php/fragment/EntityCreateOp.fragment.php +26 -0
- package/project/.sdk/src/cmp/php/fragment/EntityListOp.fragment.php +23 -0
- package/project/.sdk/src/cmp/php/fragment/EntityLoadOp.fragment.php +29 -0
- package/project/.sdk/src/cmp/php/fragment/EntityRemoveOp.fragment.php +29 -0
- package/project/.sdk/src/cmp/php/fragment/EntityUpdateOp.fragment.php +29 -0
- package/project/.sdk/src/cmp/php/fragment/Main.fragment.php +233 -0
- package/project/.sdk/src/cmp/php/fragment/SdkError.fragment.php +24 -0
- package/project/.sdk/src/cmp/php/tsconfig.json +15 -0
- package/project/.sdk/src/cmp/php/utility_php.ts +85 -0
- package/project/.sdk/src/cmp/py/Config_py.ts +93 -0
- package/project/.sdk/src/cmp/py/EntityOperation_py.ts +44 -0
- package/project/.sdk/src/cmp/py/Entity_py.ts +62 -0
- package/project/.sdk/src/cmp/py/MainEntity_py.ts +22 -0
- package/project/.sdk/src/cmp/py/Main_py.ts +156 -0
- package/project/.sdk/src/cmp/py/Package_py.ts +75 -0
- package/project/.sdk/src/cmp/py/ReadmeExplanation_py.ts +41 -0
- package/project/.sdk/src/cmp/py/ReadmeHowto_py.ts +98 -0
- package/project/.sdk/src/cmp/py/ReadmeInstall_py.ts +25 -0
- package/project/.sdk/src/cmp/py/ReadmeModel_py.ts +130 -0
- package/project/.sdk/src/cmp/py/ReadmeQuick_py.ts +100 -0
- package/project/.sdk/src/cmp/py/ReadmeTopHowto_py.ts +24 -0
- package/project/.sdk/src/cmp/py/ReadmeTopQuick_py.ts +56 -0
- package/project/.sdk/src/cmp/py/ReadmeTopTest_py.ts +38 -0
- package/project/.sdk/src/cmp/py/TestDirect_py.ts +248 -0
- package/project/.sdk/src/cmp/py/TestEntity_py.ts +475 -0
- package/project/.sdk/src/cmp/py/Test_py.ts +55 -0
- package/project/.sdk/src/cmp/py/fragment/Entity.fragment.py +112 -0
- package/project/.sdk/src/cmp/py/fragment/EntityCreateOp.fragment.py +25 -0
- package/project/.sdk/src/cmp/py/fragment/EntityListOp.fragment.py +22 -0
- package/project/.sdk/src/cmp/py/fragment/EntityLoadOp.fragment.py +27 -0
- package/project/.sdk/src/cmp/py/fragment/EntityRemoveOp.fragment.py +27 -0
- package/project/.sdk/src/cmp/py/fragment/EntityUpdateOp.fragment.py +27 -0
- package/project/.sdk/src/cmp/py/fragment/Main.fragment.py +222 -0
- package/project/.sdk/src/cmp/py/fragment/SdkError.fragment.py +16 -0
- package/project/.sdk/src/cmp/py/tsconfig.json +15 -0
- package/project/.sdk/src/cmp/py/utility_py.ts +84 -0
- package/project/.sdk/src/cmp/rb/Config_rb.ts +101 -0
- package/project/.sdk/src/cmp/rb/EntityOperation_rb.ts +44 -0
- package/project/.sdk/src/cmp/rb/Entity_rb.ts +62 -0
- package/project/.sdk/src/cmp/rb/MainEntity_rb.ts +23 -0
- package/project/.sdk/src/cmp/rb/Main_rb.ts +130 -0
- package/project/.sdk/src/cmp/rb/Package_rb.ts +111 -0
- package/project/.sdk/src/cmp/rb/ReadmeExplanation_rb.ts +42 -0
- package/project/.sdk/src/cmp/rb/ReadmeHowto_rb.ts +98 -0
- package/project/.sdk/src/cmp/rb/ReadmeInstall_rb.ts +31 -0
- package/project/.sdk/src/cmp/rb/ReadmeModel_rb.ts +129 -0
- package/project/.sdk/src/cmp/rb/ReadmeQuick_rb.ts +99 -0
- package/project/.sdk/src/cmp/rb/ReadmeTopHowto_rb.ts +24 -0
- package/project/.sdk/src/cmp/rb/ReadmeTopQuick_rb.ts +55 -0
- package/project/.sdk/src/cmp/rb/ReadmeTopTest_rb.ts +38 -0
- package/project/.sdk/src/cmp/rb/TestDirect_rb.ts +260 -0
- package/project/.sdk/src/cmp/rb/TestEntity_rb.ts +476 -0
- package/project/.sdk/src/cmp/rb/Test_rb.ts +50 -0
- package/project/.sdk/src/cmp/rb/fragment/Entity.fragment.rb +116 -0
- package/project/.sdk/src/cmp/rb/fragment/EntityCreateOp.fragment.rb +25 -0
- package/project/.sdk/src/cmp/rb/fragment/EntityListOp.fragment.rb +20 -0
- package/project/.sdk/src/cmp/rb/fragment/EntityLoadOp.fragment.rb +26 -0
- package/project/.sdk/src/cmp/rb/fragment/EntityRemoveOp.fragment.rb +26 -0
- package/project/.sdk/src/cmp/rb/fragment/EntityUpdateOp.fragment.rb +26 -0
- package/project/.sdk/src/cmp/rb/fragment/Main.fragment.rb +203 -0
- package/project/.sdk/src/cmp/rb/fragment/SdkError.fragment.rb +16 -0
- package/project/.sdk/src/cmp/rb/tsconfig.json +15 -0
- package/project/.sdk/src/cmp/rb/utility_rb.ts +84 -0
- package/project/.sdk/src/cmp/ts/ReadmeExplanation_ts.ts +34 -0
- package/project/.sdk/src/cmp/ts/ReadmeHowto_ts.ts +123 -0
- package/project/.sdk/src/cmp/ts/ReadmeInstall_ts.ts +1 -1
- package/project/.sdk/src/cmp/ts/ReadmeModel_ts.ts +159 -0
- package/project/.sdk/src/cmp/ts/ReadmeQuick_ts.ts +69 -54
- package/project/.sdk/src/cmp/ts/ReadmeTopHowto_ts.ts +25 -0
- package/project/.sdk/src/cmp/ts/ReadmeTopQuick_ts.ts +65 -0
- package/project/.sdk/src/cmp/ts/ReadmeTopTest_ts.ts +36 -0
- package/project/.sdk/src/cmp/ts/fragment/Main.fragment.ts +0 -3
- package/project/.sdk/tm/go/feature/log_feature.go +133 -0
- package/project/.sdk/tm/go/src/feature/log/.gitkeep +0 -0
- package/project/.sdk/tm/lua/LICENSE +22 -0
- package/project/.sdk/tm/lua/Makefile +10 -0
- package/project/.sdk/tm/lua/core/context.lua +208 -0
- package/project/.sdk/tm/lua/core/control.lua +17 -0
- package/project/.sdk/tm/lua/core/error.lua +30 -0
- package/project/.sdk/tm/lua/core/helpers.lua +30 -0
- package/project/.sdk/tm/lua/core/operation.lua +51 -0
- package/project/.sdk/tm/lua/core/response.lua +45 -0
- package/project/.sdk/tm/lua/core/result.lua +58 -0
- package/project/.sdk/tm/lua/core/spec.lua +29 -0
- package/project/.sdk/tm/lua/core/utility_type.lua +90 -0
- package/project/.sdk/tm/lua/feature/base_feature.lua +35 -0
- package/project/.sdk/tm/lua/feature/log_feature.lua +80 -0
- package/project/.sdk/tm/lua/feature/test_feature.lua +202 -0
- package/project/.sdk/tm/lua/src/feature/README.md +3 -0
- package/project/.sdk/tm/lua/src/feature/base/.gitkeep +0 -0
- package/project/.sdk/tm/lua/src/feature/log/.gitkeep +0 -0
- package/project/.sdk/tm/lua/src/feature/test/.gitkeep +0 -0
- package/project/.sdk/tm/lua/test/runner.lua +86 -0
- package/project/.sdk/tm/lua/utility/clean.lua +7 -0
- package/project/.sdk/tm/lua/utility/done.lua +19 -0
- package/project/.sdk/tm/lua/utility/feature_add.lua +8 -0
- package/project/.sdk/tm/lua/utility/feature_hook.lua +21 -0
- package/project/.sdk/tm/lua/utility/feature_init.lua +24 -0
- package/project/.sdk/tm/lua/utility/fetcher.lua +96 -0
- package/project/.sdk/tm/lua/utility/make_context.lua +9 -0
- package/project/.sdk/tm/lua/utility/make_error.lua +73 -0
- package/project/.sdk/tm/lua/utility/make_fetch_def.lua +43 -0
- package/project/.sdk/tm/lua/utility/make_options.lua +116 -0
- package/project/.sdk/tm/lua/utility/make_point.lua +92 -0
- package/project/.sdk/tm/lua/utility/make_request.lua +58 -0
- package/project/.sdk/tm/lua/utility/make_response.lua +44 -0
- package/project/.sdk/tm/lua/utility/make_result.lua +51 -0
- package/project/.sdk/tm/lua/utility/make_spec.lua +72 -0
- package/project/.sdk/tm/lua/utility/make_url.lua +46 -0
- package/project/.sdk/tm/lua/utility/param.lua +68 -0
- package/project/.sdk/tm/lua/utility/prepare_auth.lua +39 -0
- package/project/.sdk/tm/lua/utility/prepare_body.lua +14 -0
- package/project/.sdk/tm/lua/utility/prepare_headers.lua +20 -0
- package/project/.sdk/tm/lua/utility/prepare_method.lua +17 -0
- package/project/.sdk/tm/lua/utility/prepare_params.lua +36 -0
- package/project/.sdk/tm/lua/utility/prepare_path.lua +19 -0
- package/project/.sdk/tm/lua/utility/prepare_query.lua +41 -0
- package/project/.sdk/tm/lua/utility/register.lua +71 -0
- package/project/.sdk/tm/lua/utility/result_basic.lua +32 -0
- package/project/.sdk/tm/lua/utility/result_body.lua +17 -0
- package/project/.sdk/tm/lua/utility/result_headers.lua +22 -0
- package/project/.sdk/tm/lua/utility/struct/struct.lua +3417 -0
- package/project/.sdk/tm/lua/utility/transform_request.lua +31 -0
- package/project/.sdk/tm/lua/utility/transform_response.lua +44 -0
- package/project/.sdk/tm/php/LICENSE +22 -0
- package/project/.sdk/tm/php/Makefile +10 -0
- package/project/.sdk/tm/php/core/Context.php +139 -0
- package/project/.sdk/tm/php/core/Control.php +18 -0
- package/project/.sdk/tm/php/core/Error.php +37 -0
- package/project/.sdk/tm/php/core/Helpers.php +25 -0
- package/project/.sdk/tm/php/core/Operation.php +36 -0
- package/project/.sdk/tm/php/core/Response.php +30 -0
- package/project/.sdk/tm/php/core/Result.php +35 -0
- package/project/.sdk/tm/php/core/Spec.php +38 -0
- package/project/.sdk/tm/php/core/UtilityType.php +89 -0
- package/project/.sdk/tm/php/feature/BaseFeature.php +37 -0
- package/project/.sdk/tm/php/feature/LogFeature.php +65 -0
- package/project/.sdk/tm/php/feature/TestFeature.php +193 -0
- package/project/.sdk/tm/php/src/feature/README.md +3 -0
- package/project/.sdk/tm/php/src/feature/base/.gitkeep +0 -0
- package/project/.sdk/tm/php/src/feature/log/.gitkeep +0 -0
- package/project/.sdk/tm/php/src/feature/test/.gitkeep +0 -0
- package/project/.sdk/tm/php/test/Runner.php +89 -0
- package/project/.sdk/tm/php/utility/Clean.php +12 -0
- package/project/.sdk/tm/php/utility/Done.php +26 -0
- package/project/.sdk/tm/php/utility/FeatureAdd.php +12 -0
- package/project/.sdk/tm/php/utility/FeatureHook.php +23 -0
- package/project/.sdk/tm/php/utility/FeatureInit.php +25 -0
- package/project/.sdk/tm/php/utility/Fetcher.php +101 -0
- package/project/.sdk/tm/php/utility/MakeContext.php +14 -0
- package/project/.sdk/tm/php/utility/MakeError.php +59 -0
- package/project/.sdk/tm/php/utility/MakeFetchDef.php +36 -0
- package/project/.sdk/tm/php/utility/MakeOptions.php +98 -0
- package/project/.sdk/tm/php/utility/MakePoint.php +87 -0
- package/project/.sdk/tm/php/utility/MakeRequest.php +57 -0
- package/project/.sdk/tm/php/utility/MakeResponse.php +43 -0
- package/project/.sdk/tm/php/utility/MakeResult.php +50 -0
- package/project/.sdk/tm/php/utility/MakeSpec.php +64 -0
- package/project/.sdk/tm/php/utility/MakeUrl.php +41 -0
- package/project/.sdk/tm/php/utility/Param.php +66 -0
- package/project/.sdk/tm/php/utility/PrepareAuth.php +33 -0
- package/project/.sdk/tm/php/utility/PrepareBody.php +15 -0
- package/project/.sdk/tm/php/utility/PrepareHeaders.php +18 -0
- package/project/.sdk/tm/php/utility/PrepareMethod.php +21 -0
- package/project/.sdk/tm/php/utility/PrepareParams.php +34 -0
- package/project/.sdk/tm/php/utility/PreparePath.php +20 -0
- package/project/.sdk/tm/php/utility/PrepareQuery.php +32 -0
- package/project/.sdk/tm/php/utility/Register.php +67 -0
- package/project/.sdk/tm/php/utility/ResultBasic.php +29 -0
- package/project/.sdk/tm/php/utility/ResultBody.php +17 -0
- package/project/.sdk/tm/php/utility/ResultHeaders.php +21 -0
- package/project/.sdk/tm/php/utility/TransformRequest.php +27 -0
- package/project/.sdk/tm/php/utility/TransformResponse.php +42 -0
- package/project/.sdk/tm/php/utility/struct/Struct.php +3431 -0
- package/project/.sdk/tm/py/Makefile +10 -0
- package/project/.sdk/tm/py/core/__init__.py +0 -0
- package/project/.sdk/tm/py/core/context.py +199 -0
- package/project/.sdk/tm/py/core/control.py +12 -0
- package/project/.sdk/tm/py/core/error.py +18 -0
- package/project/.sdk/tm/py/core/helpers.py +15 -0
- package/project/.sdk/tm/py/core/operation.py +37 -0
- package/project/.sdk/tm/py/core/response.py +34 -0
- package/project/.sdk/tm/py/core/result.py +44 -0
- package/project/.sdk/tm/py/core/spec.py +23 -0
- package/project/.sdk/tm/py/core/utility_type.py +82 -0
- package/project/.sdk/tm/py/entity/__init__.py +0 -0
- package/project/.sdk/tm/py/feature/__init__.py +0 -0
- package/project/.sdk/tm/py/feature/base_feature.py +61 -0
- package/project/.sdk/tm/py/feature/log_feature.py +84 -0
- package/project/.sdk/tm/py/feature/test_feature.py +164 -0
- package/project/.sdk/tm/py/src/feature/README.md +3 -0
- package/project/.sdk/tm/py/src/feature/base/.gitkeep +0 -0
- package/project/.sdk/tm/py/src/feature/log/.gitkeep +0 -0
- package/project/.sdk/tm/py/src/feature/test/.gitkeep +0 -0
- package/project/.sdk/tm/py/test/__init__.py +0 -0
- package/project/.sdk/tm/py/test/runner.py +77 -0
- package/project/.sdk/tm/py/utility/__init__.py +0 -0
- package/project/.sdk/tm/py/utility/clean.py +5 -0
- package/project/.sdk/tm/py/utility/done.py +14 -0
- package/project/.sdk/tm/py/utility/feature_add.py +6 -0
- package/project/.sdk/tm/py/utility/feature_hook.py +15 -0
- package/project/.sdk/tm/py/utility/feature_init.py +18 -0
- package/project/.sdk/tm/py/utility/fetcher.py +95 -0
- package/project/.sdk/tm/py/utility/make_context.py +7 -0
- package/project/.sdk/tm/py/utility/make_error.py +64 -0
- package/project/.sdk/tm/py/utility/make_fetch_def.py +37 -0
- package/project/.sdk/tm/py/utility/make_options.py +103 -0
- package/project/.sdk/tm/py/utility/make_point.py +74 -0
- package/project/.sdk/tm/py/utility/make_request.py +52 -0
- package/project/.sdk/tm/py/utility/make_response.py +36 -0
- package/project/.sdk/tm/py/utility/make_result.py +41 -0
- package/project/.sdk/tm/py/utility/make_spec.py +68 -0
- package/project/.sdk/tm/py/utility/make_url.py +34 -0
- package/project/.sdk/tm/py/utility/param.py +55 -0
- package/project/.sdk/tm/py/utility/prepare_auth.py +34 -0
- package/project/.sdk/tm/py/utility/prepare_body.py +11 -0
- package/project/.sdk/tm/py/utility/prepare_headers.py +17 -0
- package/project/.sdk/tm/py/utility/prepare_method.py +15 -0
- package/project/.sdk/tm/py/utility/prepare_params.py +28 -0
- package/project/.sdk/tm/py/utility/prepare_path.py +16 -0
- package/project/.sdk/tm/py/utility/prepare_query.py +33 -0
- package/project/.sdk/tm/py/utility/register.py +68 -0
- package/project/.sdk/tm/py/utility/result_basic.py +26 -0
- package/project/.sdk/tm/py/utility/result_body.py +13 -0
- package/project/.sdk/tm/py/utility/result_headers.py +17 -0
- package/project/.sdk/tm/py/utility/transform_request.py +27 -0
- package/project/.sdk/tm/py/utility/transform_response.py +39 -0
- package/project/.sdk/tm/py/utility/voxgig_struct/__init__.py +72 -0
- package/project/.sdk/tm/py/utility/voxgig_struct/voxgig_struct.py +2770 -0
- package/project/.sdk/tm/rb/Gemfile +4 -0
- package/project/.sdk/tm/rb/LICENSE +22 -0
- package/project/.sdk/tm/rb/Makefile +10 -0
- package/project/.sdk/tm/rb/core/context.rb +105 -0
- package/project/.sdk/tm/rb/core/control.rb +11 -0
- package/project/.sdk/tm/rb/core/error.rb +24 -0
- package/project/.sdk/tm/rb/core/helpers.rb +16 -0
- package/project/.sdk/tm/rb/core/operation.rb +26 -0
- package/project/.sdk/tm/rb/core/response.rb +20 -0
- package/project/.sdk/tm/rb/core/result.rb +23 -0
- package/project/.sdk/tm/rb/core/spec.rb +23 -0
- package/project/.sdk/tm/rb/core/utility_type.rb +32 -0
- package/project/.sdk/tm/rb/feature/base_feature.rb +30 -0
- package/project/.sdk/tm/rb/feature/log_feature.rb +50 -0
- package/project/.sdk/tm/rb/feature/test_feature.rb +154 -0
- package/project/.sdk/tm/rb/src/feature/README.md +3 -0
- package/project/.sdk/tm/rb/src/feature/base/.gitkeep +0 -0
- package/project/.sdk/tm/rb/src/feature/log/.gitkeep +0 -0
- package/project/.sdk/tm/rb/src/feature/test/.gitkeep +0 -0
- package/project/.sdk/tm/rb/test/runner.rb +65 -0
- package/project/.sdk/tm/rb/utility/clean.rb +4 -0
- package/project/.sdk/tm/rb/utility/done.rb +14 -0
- package/project/.sdk/tm/rb/utility/feature_add.rb +6 -0
- package/project/.sdk/tm/rb/utility/feature_hook.rb +11 -0
- package/project/.sdk/tm/rb/utility/feature_init.rb +16 -0
- package/project/.sdk/tm/rb/utility/fetcher.rb +67 -0
- package/project/.sdk/tm/rb/utility/make_context.rb +7 -0
- package/project/.sdk/tm/rb/utility/make_error.rb +44 -0
- package/project/.sdk/tm/rb/utility/make_fetch_def.rb +24 -0
- package/project/.sdk/tm/rb/utility/make_options.rb +57 -0
- package/project/.sdk/tm/rb/utility/make_point.rb +77 -0
- package/project/.sdk/tm/rb/utility/make_request.rb +44 -0
- package/project/.sdk/tm/rb/utility/make_response.rb +25 -0
- package/project/.sdk/tm/rb/utility/make_result.rb +33 -0
- package/project/.sdk/tm/rb/utility/make_spec.rb +50 -0
- package/project/.sdk/tm/rb/utility/make_url.rb +32 -0
- package/project/.sdk/tm/rb/utility/param.rb +48 -0
- package/project/.sdk/tm/rb/utility/prepare_auth.rb +26 -0
- package/project/.sdk/tm/rb/utility/prepare_body.rb +6 -0
- package/project/.sdk/tm/rb/utility/prepare_headers.rb +11 -0
- package/project/.sdk/tm/rb/utility/prepare_method.rb +5 -0
- package/project/.sdk/tm/rb/utility/prepare_params.rb +25 -0
- package/project/.sdk/tm/rb/utility/prepare_path.rb +13 -0
- package/project/.sdk/tm/rb/utility/prepare_query.rb +22 -0
- package/project/.sdk/tm/rb/utility/register.rb +63 -0
- package/project/.sdk/tm/rb/utility/result_basic.rb +23 -0
- package/project/.sdk/tm/rb/utility/result_body.rb +11 -0
- package/project/.sdk/tm/rb/utility/result_headers.rb +15 -0
- package/project/.sdk/tm/rb/utility/struct/voxgig_struct.rb +2256 -0
- package/project/.sdk/tm/rb/utility/transform_request.rb +15 -0
- package/project/.sdk/tm/rb/utility/transform_response.rb +23 -0
- package/src/cmp/Readme.ts +5 -5
- package/src/cmp/ReadmeEntity.ts +77 -25
- package/src/cmp/ReadmeExplanation.ts +333 -0
- package/src/cmp/ReadmeHowto.ts +28 -0
- package/src/cmp/ReadmeIntro.ts +10 -24
- package/src/cmp/ReadmeModel.ts +57 -88
- package/src/cmp/ReadmeOptions.ts +40 -11
- package/src/cmp/ReadmeQuick.ts +4 -1
- package/src/cmp/ReadmeRef.ts +1057 -40
- package/src/cmp/ReadmeTop.ts +213 -0
- package/src/sdkgen.ts +12 -0
- package/project/.sdk/tm/go/test/exists_test.go +0 -16
package/bin/voxgig-sdkgen
CHANGED
package/dist/cmp/Readme.js
CHANGED
|
@@ -8,23 +8,23 @@ const ReadmeQuick_1 = require("./ReadmeQuick");
|
|
|
8
8
|
const ReadmeModel_1 = require("./ReadmeModel");
|
|
9
9
|
const ReadmeOptions_1 = require("./ReadmeOptions");
|
|
10
10
|
const ReadmeEntity_1 = require("./ReadmeEntity");
|
|
11
|
+
const ReadmeHowto_1 = require("./ReadmeHowto");
|
|
12
|
+
const ReadmeExplanation_1 = require("./ReadmeExplanation");
|
|
11
13
|
const ReadmeRef_1 = require("./ReadmeRef");
|
|
12
14
|
const Readme = (0, jostraca_1.cmp)(function Readme(props) {
|
|
13
15
|
const { target } = props;
|
|
14
16
|
const { model } = props.ctx$;
|
|
15
17
|
(0, jostraca_1.File)({ name: 'README.md' }, () => {
|
|
16
|
-
(0, jostraca_1.Content)(`
|
|
17
|
-
# ${model.Name} ${target.title} SDK
|
|
18
|
-
`);
|
|
19
|
-
// Sections
|
|
20
18
|
(0, ReadmeIntro_1.ReadmeIntro)({ target });
|
|
21
19
|
(0, ReadmeInstall_1.ReadmeInstall)({ target });
|
|
22
20
|
(0, ReadmeQuick_1.ReadmeQuick)({ target });
|
|
21
|
+
(0, ReadmeHowto_1.ReadmeHowto)({ target });
|
|
23
22
|
(0, ReadmeModel_1.ReadmeModel)({ target });
|
|
24
23
|
(0, ReadmeOptions_1.ReadmeOptions)({ target });
|
|
25
24
|
(0, ReadmeEntity_1.ReadmeEntity)({ target });
|
|
25
|
+
(0, ReadmeExplanation_1.ReadmeExplanation)({ target });
|
|
26
26
|
(0, jostraca_1.Content)(`
|
|
27
|
-
## Reference
|
|
27
|
+
## Full Reference
|
|
28
28
|
|
|
29
29
|
See [REFERENCE.md](REFERENCE.md) for complete API reference
|
|
30
30
|
documentation including all method signatures, entity field schemas,
|
package/dist/cmp/Readme.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Readme.js","sourceRoot":"","sources":["../../src/cmp/Readme.ts"],"names":[],"mappings":";;;AACA,uCAA6C;AAG7C,+CAA2C;AAC3C,mDAA+C;AAC/C,+CAA2C;AAC3C,+CAA2C;AAC3C,mDAA+C;AAC/C,iDAA6C;AAC7C,2CAAuC;AAGvC,MAAM,MAAM,GAAG,IAAA,cAAG,EAAC,SAAS,MAAM,CAAC,KAAU;IAC3C,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;IACxB,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,CAAA;IAE5B,IAAA,eAAI,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,GAAG,EAAE;QAE/B,IAAA,
|
|
1
|
+
{"version":3,"file":"Readme.js","sourceRoot":"","sources":["../../src/cmp/Readme.ts"],"names":[],"mappings":";;;AACA,uCAA6C;AAG7C,+CAA2C;AAC3C,mDAA+C;AAC/C,+CAA2C;AAC3C,+CAA2C;AAC3C,mDAA+C;AAC/C,iDAA6C;AAC7C,+CAA2C;AAC3C,2DAAuD;AACvD,2CAAuC;AAGvC,MAAM,MAAM,GAAG,IAAA,cAAG,EAAC,SAAS,MAAM,CAAC,KAAU;IAC3C,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;IACxB,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,CAAA;IAE5B,IAAA,eAAI,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,GAAG,EAAE;QAE/B,IAAA,yBAAW,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QACvB,IAAA,6BAAa,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QACzB,IAAA,yBAAW,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QACvB,IAAA,yBAAW,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QACvB,IAAA,yBAAW,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QACvB,IAAA,6BAAa,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QACzB,IAAA,2BAAY,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QACxB,IAAA,qCAAiB,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QAE7B,IAAA,kBAAO,EAAC;;;;;;CAMX,CAAC,CAAA;IACA,CAAC,CAAC,CAAA;IAEF,4CAA4C;IAC5C,IAAA,qBAAS,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;AACvB,CAAC,CAAC,CAAA;AAIA,wBAAM"}
|
package/dist/cmp/ReadmeEntity.js
CHANGED
|
@@ -4,17 +4,20 @@ exports.ReadmeEntity = void 0;
|
|
|
4
4
|
const jostraca_1 = require("jostraca");
|
|
5
5
|
const types_1 = require("../types");
|
|
6
6
|
const OP_DESC = {
|
|
7
|
-
load: { method: 'load(match)', desc: 'Load a single entity by match criteria.' },
|
|
8
|
-
list: { method: 'list(match)', desc: 'List entities matching the criteria.' },
|
|
9
|
-
create: { method: 'create(data)', desc: 'Create a new entity with the given data.' },
|
|
10
|
-
update: { method: 'update(data)', desc: 'Update an existing entity.' },
|
|
11
|
-
remove: { method: 'remove(match)', desc: 'Remove the matching entity.' },
|
|
7
|
+
load: { method: 'load(match)', goMethod: 'Load(match, ctrl)', desc: 'Load a single entity by match criteria.' },
|
|
8
|
+
list: { method: 'list(match)', goMethod: 'List(match, ctrl)', desc: 'List entities matching the criteria.' },
|
|
9
|
+
create: { method: 'create(data)', goMethod: 'Create(data, ctrl)', desc: 'Create a new entity with the given data.' },
|
|
10
|
+
update: { method: 'update(data)', goMethod: 'Update(data, ctrl)', desc: 'Update an existing entity.' },
|
|
11
|
+
remove: { method: 'remove(match)', goMethod: 'Remove(match, ctrl)', desc: 'Remove the matching entity.' },
|
|
12
12
|
};
|
|
13
13
|
const ReadmeEntity = (0, jostraca_1.cmp)(function ReadmeEntity(props) {
|
|
14
|
-
const {
|
|
14
|
+
const { target } = props;
|
|
15
|
+
const { model } = props.ctx$;
|
|
15
16
|
const entity = (0, types_1.getModelPath)(model, `main.${types_1.KIT}.entity`);
|
|
17
|
+
const isGo = target.name === 'go';
|
|
18
|
+
const lang = isGo ? 'go' : 'ts';
|
|
16
19
|
const publishedEntities = (0, jostraca_1.each)(entity)
|
|
17
|
-
.filter((entity) => entity.
|
|
20
|
+
.filter((entity) => entity.active !== false);
|
|
18
21
|
if (0 === publishedEntities.length) {
|
|
19
22
|
return;
|
|
20
23
|
}
|
|
@@ -25,7 +28,7 @@ const ReadmeEntity = (0, jostraca_1.cmp)(function ReadmeEntity(props) {
|
|
|
25
28
|
`);
|
|
26
29
|
publishedEntities.map((entity) => {
|
|
27
30
|
const opnames = Object.keys(entity.op || {});
|
|
28
|
-
const fields = entity.
|
|
31
|
+
const fields = entity.fields || [];
|
|
29
32
|
(0, jostraca_1.Content)(`
|
|
30
33
|
### ${entity.Name}
|
|
31
34
|
|
|
@@ -35,9 +38,16 @@ const ReadmeEntity = (0, jostraca_1.cmp)(function ReadmeEntity(props) {
|
|
|
35
38
|
|
|
36
39
|
`);
|
|
37
40
|
}
|
|
38
|
-
(
|
|
41
|
+
if (isGo) {
|
|
42
|
+
(0, jostraca_1.Content)(`Create an instance: \`${entity.name} := client.${entity.Name}(nil)\`
|
|
39
43
|
|
|
40
44
|
`);
|
|
45
|
+
}
|
|
46
|
+
else {
|
|
47
|
+
(0, jostraca_1.Content)(`Create an instance: \`const ${entity.name} = client.${entity.Name}()\`
|
|
48
|
+
|
|
49
|
+
`);
|
|
50
|
+
}
|
|
41
51
|
// Operations table
|
|
42
52
|
if (opnames.length > 0) {
|
|
43
53
|
(0, jostraca_1.Content)(`#### Operations
|
|
@@ -48,7 +58,8 @@ const ReadmeEntity = (0, jostraca_1.cmp)(function ReadmeEntity(props) {
|
|
|
48
58
|
opnames.map((opname) => {
|
|
49
59
|
const info = OP_DESC[opname];
|
|
50
60
|
if (info) {
|
|
51
|
-
|
|
61
|
+
const method = isGo ? info.goMethod : info.method;
|
|
62
|
+
(0, jostraca_1.Content)(`| \`${method}\` | ${info.desc} |
|
|
52
63
|
`);
|
|
53
64
|
}
|
|
54
65
|
});
|
|
@@ -71,40 +82,79 @@ const ReadmeEntity = (0, jostraca_1.cmp)(function ReadmeEntity(props) {
|
|
|
71
82
|
`);
|
|
72
83
|
}
|
|
73
84
|
// Example usage
|
|
74
|
-
if (
|
|
75
|
-
(
|
|
85
|
+
if (isGo) {
|
|
86
|
+
if (opnames.includes('load')) {
|
|
87
|
+
(0, jostraca_1.Content)(`#### Example: Load
|
|
88
|
+
|
|
89
|
+
\`\`\`go
|
|
90
|
+
result, err := client.${entity.Name}(nil).Load(map[string]any{"id": "${entity.name}_id"}, nil)
|
|
91
|
+
\`\`\`
|
|
92
|
+
|
|
93
|
+
`);
|
|
94
|
+
}
|
|
95
|
+
if (opnames.includes('list')) {
|
|
96
|
+
(0, jostraca_1.Content)(`#### Example: List
|
|
97
|
+
|
|
98
|
+
\`\`\`go
|
|
99
|
+
results, err := client.${entity.Name}(nil).List(nil, nil)
|
|
100
|
+
\`\`\`
|
|
101
|
+
|
|
102
|
+
`);
|
|
103
|
+
}
|
|
104
|
+
if (opnames.includes('create')) {
|
|
105
|
+
(0, jostraca_1.Content)(`#### Example: Create
|
|
106
|
+
|
|
107
|
+
\`\`\`go
|
|
108
|
+
result, err := client.${entity.Name}(nil).Create(map[string]any{
|
|
109
|
+
`);
|
|
110
|
+
(0, jostraca_1.each)(fields, (field) => {
|
|
111
|
+
if ('id' !== field.name && field.req) {
|
|
112
|
+
(0, jostraca_1.Content)(` "${field.name}": /* ${field.type || 'value'} */,
|
|
113
|
+
`);
|
|
114
|
+
}
|
|
115
|
+
});
|
|
116
|
+
(0, jostraca_1.Content)(`}, nil)
|
|
117
|
+
\`\`\`
|
|
118
|
+
|
|
119
|
+
`);
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
else {
|
|
123
|
+
if (opnames.includes('load')) {
|
|
124
|
+
(0, jostraca_1.Content)(`#### Example: Load
|
|
76
125
|
|
|
77
126
|
\`\`\`ts
|
|
78
127
|
const ${entity.name} = await client.${entity.Name}().load({ id: '${entity.name}_id' })
|
|
79
128
|
\`\`\`
|
|
80
129
|
|
|
81
130
|
`);
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
131
|
+
}
|
|
132
|
+
if (opnames.includes('list')) {
|
|
133
|
+
(0, jostraca_1.Content)(`#### Example: List
|
|
85
134
|
|
|
86
135
|
\`\`\`ts
|
|
87
136
|
const ${entity.name}s = await client.${entity.Name}().list()
|
|
88
137
|
\`\`\`
|
|
89
138
|
|
|
90
139
|
`);
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
140
|
+
}
|
|
141
|
+
if (opnames.includes('create')) {
|
|
142
|
+
(0, jostraca_1.Content)(`#### Example: Create
|
|
94
143
|
|
|
95
144
|
\`\`\`ts
|
|
96
145
|
const ${entity.name} = await client.${entity.Name}().create({
|
|
97
146
|
`);
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
147
|
+
(0, jostraca_1.each)(fields, (field) => {
|
|
148
|
+
if ('id' !== field.name && field.req) {
|
|
149
|
+
(0, jostraca_1.Content)(` ${field.name}: /* ${field.type || 'value'} */,
|
|
101
150
|
`);
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
151
|
+
}
|
|
152
|
+
});
|
|
153
|
+
(0, jostraca_1.Content)(`})
|
|
105
154
|
\`\`\`
|
|
106
155
|
|
|
107
156
|
`);
|
|
157
|
+
}
|
|
108
158
|
}
|
|
109
159
|
});
|
|
110
160
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ReadmeEntity.js","sourceRoot":"","sources":["../../src/cmp/ReadmeEntity.ts"],"names":[],"mappings":";;;AACA,uCAA6C;AAE7C,oCAGiB;AAGjB,MAAM,OAAO,
|
|
1
|
+
{"version":3,"file":"ReadmeEntity.js","sourceRoot":"","sources":["../../src/cmp/ReadmeEntity.ts"],"names":[],"mappings":";;;AACA,uCAA6C;AAE7C,oCAGiB;AAGjB,MAAM,OAAO,GAAuE;IAClF,IAAI,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,mBAAmB,EAAE,IAAI,EAAE,yCAAyC,EAAE;IAC/G,IAAI,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,mBAAmB,EAAE,IAAI,EAAE,sCAAsC,EAAE;IAC5G,MAAM,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,EAAE,0CAA0C,EAAE;IACpH,MAAM,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,EAAE,4BAA4B,EAAE;IACtG,MAAM,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,QAAQ,EAAE,qBAAqB,EAAE,IAAI,EAAE,6BAA6B,EAAE;CAC1G,CAAA;AAGD,MAAM,YAAY,GAAG,IAAA,cAAG,EAAC,SAAS,YAAY,CAAC,KAAU;IACvD,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;IACxB,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,CAAA;IAE5B,MAAM,MAAM,GAAG,IAAA,oBAAY,EAAC,KAAK,EAAE,QAAQ,WAAG,SAAS,CAAC,CAAA;IACxD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,KAAK,IAAI,CAAA;IACjC,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAA;IAE/B,MAAM,iBAAiB,GAAG,IAAA,eAAI,EAAC,MAAM,CAAC;SACnC,MAAM,CAAC,CAAC,MAAW,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,KAAK,CAAC,CAAA;IAEnD,IAAI,CAAC,KAAK,iBAAiB,CAAC,MAAM,EAAE,CAAC;QACnC,OAAM;IACR,CAAC;IAED,IAAA,kBAAO,EAAC;;;;CAIT,CAAC,CAAA;IAEA,iBAAiB,CAAC,GAAG,CAAC,CAAC,MAAW,EAAE,EAAE;QACpC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAA;QAC5C,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,EAAE,CAAA;QAElC,IAAA,kBAAO,EAAC;MACN,MAAM,CAAC,IAAI;;CAEhB,CAAC,CAAA;QAEE,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,IAAA,kBAAO,EAAC,GAAG,MAAM,CAAC,KAAK;;CAE5B,CAAC,CAAA;QACE,CAAC;QAED,IAAI,IAAI,EAAE,CAAC;YACT,IAAA,kBAAO,EAAC,yBAAyB,MAAM,CAAC,IAAI,cAAc,MAAM,CAAC,IAAI;;CAE1E,CAAC,CAAA;QACE,CAAC;aACI,CAAC;YACJ,IAAA,kBAAO,EAAC,+BAA+B,MAAM,CAAC,IAAI,aAAa,MAAM,CAAC,IAAI;;CAE/E,CAAC,CAAA;QACE,CAAC;QAED,mBAAmB;QACnB,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,IAAA,kBAAO,EAAC;;;;CAIb,CAAC,CAAA;YACI,OAAO,CAAC,GAAG,CAAC,CAAC,MAAc,EAAE,EAAE;gBAC7B,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;gBAC5B,IAAI,IAAI,EAAE,CAAC;oBACT,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAA;oBACjD,IAAA,kBAAO,EAAC,OAAO,MAAM,QAAQ,IAAI,CAAC,IAAI;CAC/C,CAAC,CAAA;gBACM,CAAC;YACH,CAAC,CAAC,CAAA;YAEF,IAAA,kBAAO,EAAC;CACb,CAAC,CAAA;QACE,CAAC;QAED,eAAe;QACf,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,IAAA,kBAAO,EAAC;;;;CAIb,CAAC,CAAA;YAEI,IAAA,eAAI,EAAC,MAAM,EAAE,CAAC,KAAU,EAAE,EAAE;gBAC1B,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,IAAI,EAAE,CAAA;gBAC9B,IAAA,kBAAO,EAAC,OAAO,KAAK,CAAC,IAAI,UAAU,KAAK,CAAC,IAAI,IAAI,KAAK,QAAQ,IAAI;CACzE,CAAC,CAAA;YACI,CAAC,CAAC,CAAA;YAEF,IAAA,kBAAO,EAAC;CACb,CAAC,CAAA;QACE,CAAC;QAED,gBAAgB;QAChB,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC7B,IAAA,kBAAO,EAAC;;;wBAGQ,MAAM,CAAC,IAAI,oCAAoC,MAAM,CAAC,IAAI;;;CAGjF,CAAC,CAAA;YACI,CAAC;YAED,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC7B,IAAA,kBAAO,EAAC;;;yBAGS,MAAM,CAAC,IAAI;;;CAGnC,CAAC,CAAA;YACI,CAAC;YAED,IAAI,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC/B,IAAA,kBAAO,EAAC;;;wBAGQ,MAAM,CAAC,IAAI;CAClC,CAAC,CAAA;gBACM,IAAA,eAAI,EAAC,MAAM,EAAE,CAAC,KAAU,EAAE,EAAE;oBAC1B,IAAI,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;wBACrC,IAAA,kBAAO,EAAC,QAAQ,KAAK,CAAC,IAAI,SAAS,KAAK,CAAC,IAAI,IAAI,OAAO;CACnE,CAAC,CAAA;oBACQ,CAAC;gBACH,CAAC,CAAC,CAAA;gBACF,IAAA,kBAAO,EAAC;;;CAGf,CAAC,CAAA;YACI,CAAC;QACH,CAAC;aACI,CAAC;YACJ,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC7B,IAAA,kBAAO,EAAC;;;QAGR,MAAM,CAAC,IAAI,mBAAmB,MAAM,CAAC,IAAI,kBAAkB,MAAM,CAAC,IAAI;;;CAG7E,CAAC,CAAA;YACI,CAAC;YAED,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC7B,IAAA,kBAAO,EAAC;;;QAGR,MAAM,CAAC,IAAI,oBAAoB,MAAM,CAAC,IAAI;;;CAGjD,CAAC,CAAA;YACI,CAAC;YAED,IAAI,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC/B,IAAA,kBAAO,EAAC;;;QAGR,MAAM,CAAC,IAAI,mBAAmB,MAAM,CAAC,IAAI;CAChD,CAAC,CAAA;gBACM,IAAA,eAAI,EAAC,MAAM,EAAE,CAAC,KAAU,EAAE,EAAE;oBAC1B,IAAI,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;wBACrC,IAAA,kBAAO,EAAC,KAAK,KAAK,CAAC,IAAI,QAAQ,KAAK,CAAC,IAAI,IAAI,OAAO;CAC/D,CAAC,CAAA;oBACQ,CAAC;gBACH,CAAC,CAAC,CAAA;gBACF,IAAA,kBAAO,EAAC;;;CAGf,CAAC,CAAA;YACI,CAAC;QACH,CAAC;IAEH,CAAC,CAAC,CAAA;AAEJ,CAAC,CAAC,CAAA;AAKA,oCAAY"}
|
|
@@ -0,0 +1,308 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ReadmeExplanation = void 0;
|
|
4
|
+
const jostraca_1 = require("jostraca");
|
|
5
|
+
const types_1 = require("../types");
|
|
6
|
+
const utility_1 = require("../utility");
|
|
7
|
+
const ReadmeExplanation = (0, jostraca_1.cmp)(function ReadmeExplanation(props) {
|
|
8
|
+
const { target, ctx$ } = props;
|
|
9
|
+
const { model } = ctx$;
|
|
10
|
+
const feature = (0, types_1.getModelPath)(model, `main.${types_1.KIT}.feature`);
|
|
11
|
+
(0, jostraca_1.Content)(`
|
|
12
|
+
## Explanation
|
|
13
|
+
|
|
14
|
+
### The operation pipeline
|
|
15
|
+
|
|
16
|
+
Every entity operation (load, list, create, update, remove) follows a
|
|
17
|
+
six-stage pipeline. Each stage fires a feature hook before executing:
|
|
18
|
+
|
|
19
|
+
\`\`\`
|
|
20
|
+
PrePoint \u2192 PreSpec \u2192 PreRequest \u2192 PreResponse \u2192 PreResult \u2192 PreDone
|
|
21
|
+
\`\`\`
|
|
22
|
+
|
|
23
|
+
- **PrePoint**: Resolves which API endpoint to call based on the
|
|
24
|
+
operation name and entity configuration.
|
|
25
|
+
- **PreSpec**: Builds the HTTP spec \u2014 URL, method, headers, body \u2014
|
|
26
|
+
from the resolved point and the caller's parameters.
|
|
27
|
+
- **PreRequest**: Sends the HTTP request. Features can intercept here
|
|
28
|
+
to replace the transport (as TestFeature does with mocks).
|
|
29
|
+
- **PreResponse**: Parses the raw HTTP response.
|
|
30
|
+
- **PreResult**: Extracts the business data from the parsed response.
|
|
31
|
+
- **PreDone**: Final stage before returning to the caller. Entity
|
|
32
|
+
state (match, data) is updated here.
|
|
33
|
+
|
|
34
|
+
`);
|
|
35
|
+
// Target-specific error description
|
|
36
|
+
if (target.name === 'py') {
|
|
37
|
+
(0, jostraca_1.Content)(`If any stage returns an error, the pipeline short-circuits and the
|
|
38
|
+
error is returned to the caller as the second element in the return tuple.
|
|
39
|
+
|
|
40
|
+
`);
|
|
41
|
+
}
|
|
42
|
+
else if (target.name === 'php') {
|
|
43
|
+
(0, jostraca_1.Content)(`If any stage returns an error, the pipeline short-circuits and the
|
|
44
|
+
error is returned to the caller as the second element in the return array.
|
|
45
|
+
|
|
46
|
+
`);
|
|
47
|
+
}
|
|
48
|
+
else if (target.name === 'rb') {
|
|
49
|
+
(0, jostraca_1.Content)(`If any stage returns an error, the pipeline short-circuits and the
|
|
50
|
+
error is returned to the caller as a second return value.
|
|
51
|
+
|
|
52
|
+
`);
|
|
53
|
+
}
|
|
54
|
+
else if (target.name === 'lua') {
|
|
55
|
+
(0, jostraca_1.Content)(`If any stage returns an error, the pipeline short-circuits and the
|
|
56
|
+
error is returned to the caller as a second return value.
|
|
57
|
+
|
|
58
|
+
`);
|
|
59
|
+
}
|
|
60
|
+
else if (target.name === 'go') {
|
|
61
|
+
(0, jostraca_1.Content)(`If any stage returns an error, the pipeline short-circuits and the
|
|
62
|
+
error is returned to the caller. An unexpected panic triggers the
|
|
63
|
+
\`PreUnexpected\` hook.
|
|
64
|
+
|
|
65
|
+
`);
|
|
66
|
+
}
|
|
67
|
+
else {
|
|
68
|
+
(0, jostraca_1.Content)(`If any stage returns an error, the pipeline short-circuits and the
|
|
69
|
+
error is returned to the caller.
|
|
70
|
+
|
|
71
|
+
An unexpected exception triggers the \`PreUnexpected\` hook before
|
|
72
|
+
propagating.
|
|
73
|
+
|
|
74
|
+
`);
|
|
75
|
+
}
|
|
76
|
+
// Features and hooks
|
|
77
|
+
(0, jostraca_1.Content)(`### Features and hooks
|
|
78
|
+
|
|
79
|
+
`);
|
|
80
|
+
if (target.name === 'py') {
|
|
81
|
+
(0, jostraca_1.Content)(`Features are the extension mechanism. A feature is a Python class
|
|
82
|
+
with hook methods named after pipeline stages (e.g. \`PrePoint\`,
|
|
83
|
+
\`PreSpec\`). Each method receives the context.
|
|
84
|
+
|
|
85
|
+
`);
|
|
86
|
+
}
|
|
87
|
+
else if (target.name === 'php') {
|
|
88
|
+
(0, jostraca_1.Content)(`Features are the extension mechanism. A feature is a PHP class
|
|
89
|
+
with hook methods named after pipeline stages (e.g. \`PrePoint\`,
|
|
90
|
+
\`PreSpec\`). Each method receives the context.
|
|
91
|
+
|
|
92
|
+
`);
|
|
93
|
+
}
|
|
94
|
+
else if (target.name === 'rb') {
|
|
95
|
+
(0, jostraca_1.Content)(`Features are the extension mechanism. A feature is a Ruby class
|
|
96
|
+
with hook methods named after pipeline stages (e.g. \`PrePoint\`,
|
|
97
|
+
\`PreSpec\`). Each method receives the context.
|
|
98
|
+
|
|
99
|
+
`);
|
|
100
|
+
}
|
|
101
|
+
else if (target.name === 'lua') {
|
|
102
|
+
(0, jostraca_1.Content)(`Features are the extension mechanism. A feature is a Lua table
|
|
103
|
+
with hook methods named after pipeline stages (e.g. \`PrePoint\`,
|
|
104
|
+
\`PreSpec\`). Each method receives the context.
|
|
105
|
+
|
|
106
|
+
`);
|
|
107
|
+
}
|
|
108
|
+
else if (target.name === 'go') {
|
|
109
|
+
(0, jostraca_1.Content)(`Features are the extension mechanism. A feature implements the
|
|
110
|
+
\`Feature\` interface and provides hooks \u2014 functions keyed by pipeline
|
|
111
|
+
stage names.
|
|
112
|
+
|
|
113
|
+
`);
|
|
114
|
+
}
|
|
115
|
+
else {
|
|
116
|
+
(0, jostraca_1.Content)(`Features are the extension mechanism. A feature is an object with a
|
|
117
|
+
\`hooks\` map. Each hook key is a pipeline stage name, and the value is
|
|
118
|
+
a function that receives the context.
|
|
119
|
+
|
|
120
|
+
`);
|
|
121
|
+
}
|
|
122
|
+
(0, jostraca_1.Content)(`The SDK ships with built-in features:
|
|
123
|
+
|
|
124
|
+
`);
|
|
125
|
+
(0, jostraca_1.each)(feature, (feat) => {
|
|
126
|
+
if (!feat.active)
|
|
127
|
+
return;
|
|
128
|
+
if (!feat.Name)
|
|
129
|
+
(0, jostraca_1.names)(feat, feat.name);
|
|
130
|
+
const purpose = feat.title || feat.Name || feat.name;
|
|
131
|
+
(0, jostraca_1.Content)(`- **${feat.Name}Feature**: ${purpose}
|
|
132
|
+
`);
|
|
133
|
+
});
|
|
134
|
+
(0, jostraca_1.Content)(`
|
|
135
|
+
Features are initialized in order. Hooks fire in the order features
|
|
136
|
+
were added, so later features can override earlier ones.
|
|
137
|
+
|
|
138
|
+
`);
|
|
139
|
+
// Target-specific explanation
|
|
140
|
+
const ReadmeExplanation_sdk = (0, utility_1.requirePath)(ctx$, `./cmp/${target.name}/ReadmeExplanation_${target.name}`, { ignore: true });
|
|
141
|
+
if (ReadmeExplanation_sdk) {
|
|
142
|
+
ReadmeExplanation_sdk['ReadmeExplanation']({ target });
|
|
143
|
+
}
|
|
144
|
+
// Entity state
|
|
145
|
+
(0, jostraca_1.Content)(`### Entity state
|
|
146
|
+
|
|
147
|
+
`);
|
|
148
|
+
if (target.name === 'py') {
|
|
149
|
+
(0, jostraca_1.Content)(`Entity instances are stateful. After a successful \`load\`, the entity
|
|
150
|
+
stores the returned data and match criteria internally.
|
|
151
|
+
|
|
152
|
+
\`\`\`python
|
|
153
|
+
moon = client.Moon()
|
|
154
|
+
moon.load({"planet_id": "earth", "id": "luna"})
|
|
155
|
+
|
|
156
|
+
# moon.data_get() now returns the loaded moon data
|
|
157
|
+
# moon.match_get() returns the last match criteria
|
|
158
|
+
\`\`\`
|
|
159
|
+
|
|
160
|
+
Call \`make()\` to create a fresh instance with the same configuration
|
|
161
|
+
but no stored state.
|
|
162
|
+
|
|
163
|
+
`);
|
|
164
|
+
}
|
|
165
|
+
else if (target.name === 'php') {
|
|
166
|
+
(0, jostraca_1.Content)(`Entity instances are stateful. After a successful \`load\`, the entity
|
|
167
|
+
stores the returned data and match criteria internally.
|
|
168
|
+
|
|
169
|
+
\`\`\`php
|
|
170
|
+
$moon = $client->Moon();
|
|
171
|
+
[$result, $err] = $moon->load(["planet_id" => "earth", "id" => "luna"]);
|
|
172
|
+
|
|
173
|
+
// $moon->dataGet() now returns the loaded moon data
|
|
174
|
+
// $moon->matchGet() returns the last match criteria
|
|
175
|
+
\`\`\`
|
|
176
|
+
|
|
177
|
+
Call \`make()\` to create a fresh instance with the same configuration
|
|
178
|
+
but no stored state.
|
|
179
|
+
|
|
180
|
+
`);
|
|
181
|
+
}
|
|
182
|
+
else if (target.name === 'rb') {
|
|
183
|
+
(0, jostraca_1.Content)(`Entity instances are stateful. After a successful \`load\`, the entity
|
|
184
|
+
stores the returned data and match criteria internally.
|
|
185
|
+
|
|
186
|
+
\`\`\`ruby
|
|
187
|
+
moon = client.Moon
|
|
188
|
+
moon.load({ "planet_id" => "earth", "id" => "luna" })
|
|
189
|
+
|
|
190
|
+
# moon.data_get now returns the loaded moon data
|
|
191
|
+
# moon.match_get returns the last match criteria
|
|
192
|
+
\`\`\`
|
|
193
|
+
|
|
194
|
+
Call \`make\` to create a fresh instance with the same configuration
|
|
195
|
+
but no stored state.
|
|
196
|
+
|
|
197
|
+
`);
|
|
198
|
+
}
|
|
199
|
+
else if (target.name === 'lua') {
|
|
200
|
+
(0, jostraca_1.Content)(`Entity instances are stateful. After a successful \`load\`, the entity
|
|
201
|
+
stores the returned data and match criteria internally.
|
|
202
|
+
|
|
203
|
+
\`\`\`lua
|
|
204
|
+
local moon = client:Moon(nil)
|
|
205
|
+
moon:load({ planet_id = "earth", id = "luna" }, nil)
|
|
206
|
+
|
|
207
|
+
-- moon:data_get() now returns the loaded moon data
|
|
208
|
+
-- moon:match_get() returns the last match criteria
|
|
209
|
+
\`\`\`
|
|
210
|
+
|
|
211
|
+
Call \`make()\` to create a fresh instance with the same configuration
|
|
212
|
+
but no stored state.
|
|
213
|
+
|
|
214
|
+
`);
|
|
215
|
+
}
|
|
216
|
+
else if (target.name === 'go') {
|
|
217
|
+
(0, jostraca_1.Content)(`Entity instances are stateful. After a successful \`Load\`, the entity
|
|
218
|
+
stores the returned data and match criteria internally.
|
|
219
|
+
|
|
220
|
+
\`\`\`go
|
|
221
|
+
moon := client.Moon(nil)
|
|
222
|
+
moon.Load(map[string]any{"planet_id": "earth", "id": "luna"}, nil)
|
|
223
|
+
|
|
224
|
+
// moon.Data() now returns the loaded moon data
|
|
225
|
+
// moon.Match() returns the last match criteria
|
|
226
|
+
\`\`\`
|
|
227
|
+
|
|
228
|
+
Call \`Make()\` to create a fresh instance with the same configuration
|
|
229
|
+
but no stored state.
|
|
230
|
+
|
|
231
|
+
`);
|
|
232
|
+
}
|
|
233
|
+
else {
|
|
234
|
+
(0, jostraca_1.Content)(`Entity instances are stateful. After a successful \`load\`, the entity
|
|
235
|
+
stores the returned data and match criteria internally. Subsequent
|
|
236
|
+
calls on the same instance can rely on this state.
|
|
237
|
+
|
|
238
|
+
\`\`\`ts
|
|
239
|
+
const moon = client.Moon()
|
|
240
|
+
await moon.load({ planet_id: 'earth', id: 'luna' })
|
|
241
|
+
|
|
242
|
+
// moon.data() now returns the loaded moon data
|
|
243
|
+
// moon.match() returns { planet_id: 'earth', id: 'luna' }
|
|
244
|
+
\`\`\`
|
|
245
|
+
|
|
246
|
+
Call \`make()\` to create a fresh instance with the same configuration
|
|
247
|
+
but no stored state.
|
|
248
|
+
|
|
249
|
+
`);
|
|
250
|
+
}
|
|
251
|
+
// Direct vs entity access
|
|
252
|
+
(0, jostraca_1.Content)(`### Direct vs entity access
|
|
253
|
+
|
|
254
|
+
The entity interface handles URL construction, parameter placement,
|
|
255
|
+
and response parsing automatically. Use it for standard CRUD operations.
|
|
256
|
+
|
|
257
|
+
`);
|
|
258
|
+
if (target.name === 'py') {
|
|
259
|
+
(0, jostraca_1.Content)(`\`direct()\` gives full control over the HTTP request. Use it for
|
|
260
|
+
non-standard endpoints, bulk operations, or any path not modelled as
|
|
261
|
+
an entity. \`prepare()\` builds the request without sending it \u2014 useful
|
|
262
|
+
for debugging or custom transport.
|
|
263
|
+
|
|
264
|
+
`);
|
|
265
|
+
}
|
|
266
|
+
else if (target.name === 'php') {
|
|
267
|
+
(0, jostraca_1.Content)(`\`direct()\` gives full control over the HTTP request. Use it for
|
|
268
|
+
non-standard endpoints, bulk operations, or any path not modelled as
|
|
269
|
+
an entity. \`prepare()\` builds the request without sending it \u2014 useful
|
|
270
|
+
for debugging or custom transport.
|
|
271
|
+
|
|
272
|
+
`);
|
|
273
|
+
}
|
|
274
|
+
else if (target.name === 'rb') {
|
|
275
|
+
(0, jostraca_1.Content)(`\`direct\` gives full control over the HTTP request. Use it for
|
|
276
|
+
non-standard endpoints, bulk operations, or any path not modelled as
|
|
277
|
+
an entity. \`prepare\` builds the request without sending it \u2014 useful
|
|
278
|
+
for debugging or custom transport.
|
|
279
|
+
|
|
280
|
+
`);
|
|
281
|
+
}
|
|
282
|
+
else if (target.name === 'lua') {
|
|
283
|
+
(0, jostraca_1.Content)(`\`direct()\` gives full control over the HTTP request. Use it for
|
|
284
|
+
non-standard endpoints, bulk operations, or any path not modelled as
|
|
285
|
+
an entity. \`prepare()\` builds the request without sending it \u2014 useful
|
|
286
|
+
for debugging or custom transport.
|
|
287
|
+
|
|
288
|
+
`);
|
|
289
|
+
}
|
|
290
|
+
else if (target.name === 'go') {
|
|
291
|
+
(0, jostraca_1.Content)(`\`Direct()\` gives full control over the HTTP request. Use it for
|
|
292
|
+
non-standard endpoints, bulk operations, or any path not modelled as
|
|
293
|
+
an entity. \`Prepare()\` builds the request without sending it \u2014 useful
|
|
294
|
+
for debugging or custom transport.
|
|
295
|
+
|
|
296
|
+
`);
|
|
297
|
+
}
|
|
298
|
+
else {
|
|
299
|
+
(0, jostraca_1.Content)(`The \`direct\` method gives full control over the HTTP request. Use it
|
|
300
|
+
for non-standard endpoints, bulk operations, or any path not modelled
|
|
301
|
+
as an entity. The \`prepare\` method is useful for debugging \u2014 it
|
|
302
|
+
shows exactly what \`direct\` would send.
|
|
303
|
+
|
|
304
|
+
`);
|
|
305
|
+
}
|
|
306
|
+
});
|
|
307
|
+
exports.ReadmeExplanation = ReadmeExplanation;
|
|
308
|
+
//# sourceMappingURL=ReadmeExplanation.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ReadmeExplanation.js","sourceRoot":"","sources":["../../src/cmp/ReadmeExplanation.ts"],"names":[],"mappings":";;;AACA,uCAAoD;AAEpD,oCAGiB;AAEjB,wCAAwC;AAGxC,MAAM,iBAAiB,GAAG,IAAA,cAAG,EAAC,SAAS,iBAAiB,CAAC,KAAU;IACjE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;IAC9B,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAA;IAEtB,MAAM,OAAO,GAAG,IAAA,oBAAY,EAAC,KAAK,EAAE,QAAQ,WAAG,UAAU,CAAC,CAAA;IAE1D,IAAA,kBAAO,EAAC;;;;;;;;;;;;;;;;;;;;;;;CAuBT,CAAC,CAAA;IAEA,oCAAoC;IACpC,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QACzB,IAAA,kBAAO,EAAC;;;CAGX,CAAC,CAAA;IACA,CAAC;SACI,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;QAC/B,IAAA,kBAAO,EAAC;;;CAGX,CAAC,CAAA;IACA,CAAC;SACI,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QAC9B,IAAA,kBAAO,EAAC;;;CAGX,CAAC,CAAA;IACA,CAAC;SACI,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;QAC/B,IAAA,kBAAO,EAAC;;;CAGX,CAAC,CAAA;IACA,CAAC;SACI,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QAC9B,IAAA,kBAAO,EAAC;;;;CAIX,CAAC,CAAA;IACA,CAAC;SACI,CAAC;QACJ,IAAA,kBAAO,EAAC;;;;;;CAMX,CAAC,CAAA;IACA,CAAC;IAGD,qBAAqB;IACrB,IAAA,kBAAO,EAAC;;CAET,CAAC,CAAA;IAEA,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QACzB,IAAA,kBAAO,EAAC;;;;CAIX,CAAC,CAAA;IACA,CAAC;SACI,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;QAC/B,IAAA,kBAAO,EAAC;;;;CAIX,CAAC,CAAA;IACA,CAAC;SACI,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QAC9B,IAAA,kBAAO,EAAC;;;;CAIX,CAAC,CAAA;IACA,CAAC;SACI,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;QAC/B,IAAA,kBAAO,EAAC;;;;CAIX,CAAC,CAAA;IACA,CAAC;SACI,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QAC9B,IAAA,kBAAO,EAAC;;;;CAIX,CAAC,CAAA;IACA,CAAC;SACI,CAAC;QACJ,IAAA,kBAAO,EAAC;;;;CAIX,CAAC,CAAA;IACA,CAAC;IAED,IAAA,kBAAO,EAAC;;CAET,CAAC,CAAA;IACA,IAAA,eAAI,EAAC,OAAO,EAAE,CAAC,IAAS,EAAE,EAAE;QAC1B,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,OAAM;QACxB,IAAI,CAAC,IAAI,CAAC,IAAI;YAAE,IAAA,gBAAK,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;QACtC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAA;QACpD,IAAA,kBAAO,EAAC,OAAO,IAAI,CAAC,IAAI,cAAc,OAAO;CAChD,CAAC,CAAA;IACA,CAAC,CAAC,CAAA;IAEF,IAAA,kBAAO,EAAC;;;;CAIT,CAAC,CAAA;IAGA,8BAA8B;IAC9B,MAAM,qBAAqB,GACzB,IAAA,qBAAW,EAAC,IAAI,EAAE,SAAS,MAAM,CAAC,IAAI,sBAAsB,MAAM,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;IAE9F,IAAI,qBAAqB,EAAE,CAAC;QAC1B,qBAAqB,CAAC,mBAAmB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IACxD,CAAC;IAGD,eAAe;IACf,IAAA,kBAAO,EAAC;;CAET,CAAC,CAAA;IAEA,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QACzB,IAAA,kBAAO,EAAC;;;;;;;;;;;;;;CAcX,CAAC,CAAA;IACA,CAAC;SACI,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;QAC/B,IAAA,kBAAO,EAAC;;;;;;;;;;;;;;CAcX,CAAC,CAAA;IACA,CAAC;SACI,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QAC9B,IAAA,kBAAO,EAAC;;;;;;;;;;;;;;CAcX,CAAC,CAAA;IACA,CAAC;SACI,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;QAC/B,IAAA,kBAAO,EAAC;;;;;;;;;;;;;;CAcX,CAAC,CAAA;IACA,CAAC;SACI,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QAC9B,IAAA,kBAAO,EAAC;;;;;;;;;;;;;;CAcX,CAAC,CAAA;IACA,CAAC;SACI,CAAC;QACJ,IAAA,kBAAO,EAAC;;;;;;;;;;;;;;;CAeX,CAAC,CAAA;IACA,CAAC;IAGD,0BAA0B;IAC1B,IAAA,kBAAO,EAAC;;;;;CAKT,CAAC,CAAA;IAEA,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QACzB,IAAA,kBAAO,EAAC;;;;;CAKX,CAAC,CAAA;IACA,CAAC;SACI,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;QAC/B,IAAA,kBAAO,EAAC;;;;;CAKX,CAAC,CAAA;IACA,CAAC;SACI,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QAC9B,IAAA,kBAAO,EAAC;;;;;CAKX,CAAC,CAAA;IACA,CAAC;SACI,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;QAC/B,IAAA,kBAAO,EAAC;;;;;CAKX,CAAC,CAAA;IACA,CAAC;SACI,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QAC9B,IAAA,kBAAO,EAAC;;;;;CAKX,CAAC,CAAA;IACA,CAAC;SACI,CAAC;QACJ,IAAA,kBAAO,EAAC;;;;;CAKX,CAAC,CAAA;IACA,CAAC;AAEH,CAAC,CAAC,CAAA;AAIA,8CAAiB"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ReadmeHowto = void 0;
|
|
4
|
+
const jostraca_1 = require("jostraca");
|
|
5
|
+
const utility_1 = require("../utility");
|
|
6
|
+
const ReadmeHowto = (0, jostraca_1.cmp)(function ReadmeHowto(props) {
|
|
7
|
+
const { target, ctx$ } = props;
|
|
8
|
+
(0, jostraca_1.Content)(`
|
|
9
|
+
## How-to guides
|
|
10
|
+
|
|
11
|
+
`);
|
|
12
|
+
const ReadmeHowto_sdk = (0, utility_1.requirePath)(ctx$, `./cmp/${target.name}/ReadmeHowto_${target.name}`, { ignore: true });
|
|
13
|
+
if (ReadmeHowto_sdk) {
|
|
14
|
+
ReadmeHowto_sdk['ReadmeHowto']({ target });
|
|
15
|
+
}
|
|
16
|
+
});
|
|
17
|
+
exports.ReadmeHowto = ReadmeHowto;
|
|
18
|
+
//# sourceMappingURL=ReadmeHowto.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ReadmeHowto.js","sourceRoot":"","sources":["../../src/cmp/ReadmeHowto.ts"],"names":[],"mappings":";;;AACA,uCAAuC;AAEvC,wCAAwC;AAGxC,MAAM,WAAW,GAAG,IAAA,cAAG,EAAC,SAAS,WAAW,CAAC,KAAU;IACrD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;IAE9B,IAAA,kBAAO,EAAC;;;CAGT,CAAC,CAAA;IAEA,MAAM,eAAe,GACnB,IAAA,qBAAW,EAAC,IAAI,EAAE,SAAS,MAAM,CAAC,IAAI,gBAAgB,MAAM,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;IAExF,IAAI,eAAe,EAAE,CAAC;QACpB,eAAe,CAAC,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IAC5C,CAAC;AACH,CAAC,CAAC,CAAA;AAMA,kCAAW"}
|
package/dist/cmp/ReadmeIntro.js
CHANGED
|
@@ -2,34 +2,19 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ReadmeIntro = void 0;
|
|
4
4
|
const jostraca_1 = require("jostraca");
|
|
5
|
-
const
|
|
5
|
+
const TARGET_INTRO = {
|
|
6
|
+
ts: 'Provides a type-safe,\nentity-oriented interface with full async/await support.',
|
|
7
|
+
go: 'Provides an entity-oriented interface\nusing standard Go conventions \u2014 no generics required, data flows as\n`map[string]any`.',
|
|
8
|
+
js: 'Provides an entity-oriented\ninterface with full async/await support.',
|
|
9
|
+
};
|
|
6
10
|
const ReadmeIntro = (0, jostraca_1.cmp)(function ReadmeIntro(props) {
|
|
7
11
|
const { target } = props;
|
|
8
12
|
const { model } = props.ctx$;
|
|
9
13
|
const desc = model.main.def.desc || '';
|
|
10
|
-
const
|
|
11
|
-
|
|
12
|
-
.filter((e) => e.publish)
|
|
13
|
-
.map((e) => `\`${e.Name}\``);
|
|
14
|
-
(0, jostraca_1.Content)(`
|
|
15
|
-
## Introduction
|
|
14
|
+
const targetIntro = TARGET_INTRO[target.name] || 'Provides an entity-oriented interface.';
|
|
15
|
+
(0, jostraca_1.Content)(`# ${model.Name} ${target.title} SDK
|
|
16
16
|
|
|
17
|
-
${
|
|
18
|
-
`);
|
|
19
|
-
if (entityNames.length > 0) {
|
|
20
|
-
(0, jostraca_1.Content)(`
|
|
21
|
-
This SDK provides an entity-oriented interface for the ${model.Name} API.
|
|
22
|
-
The following entities are available: ${entityNames.join(', ')}.
|
|
23
|
-
|
|
24
|
-
`);
|
|
25
|
-
}
|
|
26
|
-
(0, jostraca_1.Content)(`
|
|
27
|
-
### Features
|
|
28
|
-
|
|
29
|
-
- Entity-based API: work with business objects directly.
|
|
30
|
-
- Type safe: full TypeScript definitions included.
|
|
31
|
-
- Direct HTTP access: call any API endpoint using \`client.direct()\`.
|
|
32
|
-
- Testable: built-in test mode with mock support.
|
|
17
|
+
The ${target.title} SDK for the ${model.Name} API. ${targetIntro}
|
|
33
18
|
|
|
34
19
|
`);
|
|
35
20
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ReadmeIntro.js","sourceRoot":"","sources":["../../src/cmp/ReadmeIntro.ts"],"names":[],"mappings":";;;AACA,uCAAuC;
|
|
1
|
+
{"version":3,"file":"ReadmeIntro.js","sourceRoot":"","sources":["../../src/cmp/ReadmeIntro.ts"],"names":[],"mappings":";;;AACA,uCAAuC;AAQvC,MAAM,YAAY,GAA2B;IAC3C,EAAE,EAAE,iFAAiF;IACrF,EAAE,EAAE,oIAAoI;IACxI,EAAE,EAAE,uEAAuE;CAC5E,CAAA;AAGD,MAAM,WAAW,GAAG,IAAA,cAAG,EAAC,SAAS,WAAW,CAAC,KAAU;IACrD,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;IACxB,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,CAAA;IAE5B,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAA;IAEtC,MAAM,WAAW,GAAG,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,wCAAwC,CAAA;IAEzF,IAAA,kBAAO,EAAC,KAAK,KAAK,CAAC,IAAI,IAAI,MAAM,CAAC,KAAK;;MAEnC,MAAM,CAAC,KAAK,gBAAgB,KAAK,CAAC,IAAI,SAAS,WAAW;;CAE/D,CAAC,CAAA;AAEF,CAAC,CAAC,CAAA;AAMA,kCAAW"}
|