@effect/platform 0.72.1 → 0.73.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/README.md +2159 -356
- package/Url/package.json +6 -0
- package/dist/cjs/HttpApi.js +22 -18
- package/dist/cjs/HttpApi.js.map +1 -1
- package/dist/cjs/HttpApiEndpoint.js.map +1 -1
- package/dist/cjs/HttpApiGroup.js.map +1 -1
- package/dist/cjs/HttpApiSchema.js +33 -4
- package/dist/cjs/HttpApiSchema.js.map +1 -1
- package/dist/cjs/HttpApiSecurity.js +2 -0
- package/dist/cjs/HttpApiSecurity.js.map +1 -1
- package/dist/cjs/OpenApi.js +132 -142
- package/dist/cjs/OpenApi.js.map +1 -1
- package/dist/cjs/OpenApiJsonSchema.js +7 -4
- package/dist/cjs/OpenApiJsonSchema.js.map +1 -1
- package/dist/cjs/Runtime.js.map +1 -1
- package/dist/cjs/Url.js +259 -0
- package/dist/cjs/Url.js.map +1 -0
- package/dist/cjs/index.js +3 -1
- package/dist/dts/HttpApi.d.ts +4 -2
- package/dist/dts/HttpApi.d.ts.map +1 -1
- package/dist/dts/HttpApiBuilder.d.ts +1 -1
- package/dist/dts/HttpApiBuilder.d.ts.map +1 -1
- package/dist/dts/HttpApiEndpoint.d.ts +16 -8
- package/dist/dts/HttpApiEndpoint.d.ts.map +1 -1
- package/dist/dts/HttpApiGroup.d.ts +1 -2
- package/dist/dts/HttpApiGroup.d.ts.map +1 -1
- package/dist/dts/HttpApiSchema.d.ts.map +1 -1
- package/dist/dts/HttpApiSecurity.d.ts +2 -0
- package/dist/dts/HttpApiSecurity.d.ts.map +1 -1
- package/dist/dts/OpenApi.d.ts +102 -111
- package/dist/dts/OpenApi.d.ts.map +1 -1
- package/dist/dts/OpenApiJsonSchema.d.ts.map +1 -1
- package/dist/dts/Runtime.d.ts +48 -0
- package/dist/dts/Runtime.d.ts.map +1 -1
- package/dist/dts/Url.d.ts +591 -0
- package/dist/dts/Url.d.ts.map +1 -0
- package/dist/dts/index.d.ts +4 -0
- package/dist/dts/index.d.ts.map +1 -1
- package/dist/esm/HttpApi.js +22 -18
- package/dist/esm/HttpApi.js.map +1 -1
- package/dist/esm/HttpApiEndpoint.js.map +1 -1
- package/dist/esm/HttpApiGroup.js.map +1 -1
- package/dist/esm/HttpApiSchema.js +30 -3
- package/dist/esm/HttpApiSchema.js.map +1 -1
- package/dist/esm/HttpApiSecurity.js +2 -0
- package/dist/esm/HttpApiSecurity.js.map +1 -1
- package/dist/esm/OpenApi.js +132 -141
- package/dist/esm/OpenApi.js.map +1 -1
- package/dist/esm/OpenApiJsonSchema.js +4 -2
- package/dist/esm/OpenApiJsonSchema.js.map +1 -1
- package/dist/esm/Runtime.js.map +1 -1
- package/dist/esm/Url.js +248 -0
- package/dist/esm/Url.js.map +1 -0
- package/dist/esm/index.js +4 -0
- package/dist/esm/index.js.map +1 -1
- package/package.json +10 -2
- package/src/HttpApi.ts +25 -26
- package/src/HttpApiBuilder.ts +1 -1
- package/src/HttpApiEndpoint.ts +22 -13
- package/src/HttpApiGroup.ts +2 -3
- package/src/HttpApiSchema.ts +33 -8
- package/src/HttpApiSecurity.ts +2 -0
- package/src/OpenApi.ts +244 -272
- package/src/OpenApiJsonSchema.ts +9 -1
- package/src/Runtime.ts +48 -0
- package/src/Url.ts +632 -0
- package/src/index.ts +5 -0
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"HttpApiSchema.d.ts","sourceRoot":"","sources":["../../src/HttpApiSchema.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAI9C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,GAAG,MAAM,kBAAkB,CAAA;AAGvC;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,OAAO,MAExC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB,EAAE,OAAO,MAAsE,CAAA;AAE5G;;;GAGG;AACH,eAAO,MAAM,yBAAyB,EAAE,OAAO,MAE9C,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB,EAAE,OAAO,MAAwE,CAAA;AAEhH;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE,OAAO,MAEpC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB,QAAS,GAAG,CAAC,WAAW,KAAG,GAAG,CAAC,WAkB7D,CAAA;AAYD;;;GAGG;AACH,eAAO,MAAM,SAAS,QAAS,GAAG,CAAC,GAAG,iBAAiB,MAAM,KAAG,MACD,CAAA;AAE/D;;;GAGG;AACH,eAAO,MAAM,kBAAkB,QAAS,GAAG,CAAC,GAAG,KAAG,OACe,CAAA;AAEjE;;;GAGG;AACH,eAAO,MAAM,YAAY,QAAS,GAAG,CAAC,GAAG,KAAG,OAAoE,CAAA;AAOhH;;;GAGG;AACH,eAAO,MAAM,WAAW,QAAS,GAAG,CAAC,GAAG,KAAG,QAA4E,CAAA;AAEvH;;;GAGG;AACH,eAAO,MAAM,QAAQ,QAAS,GAAG,CAAC,GAAG,KAAG,MAAM,GAAG,SAAmE,CAAA;AAEpH;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,eACd,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG;IACnD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACrC,KACA,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAM7B,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,MAAM,QAAS,GAAG,CAAC,GAAG,KAAG,OAerC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB,QAAS,GAAG,CAAC,GAAG,KAAG,MAAiD,CAAA;AAEpG;;;GAGG;AACH,eAAO,MAAM,gBAAgB,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAG,MAAuC,CAAA;AAE/G;;;GAGG;AACH,eAAO,MAAM,iBAAiB,QAAS,GAAG,CAAC,GAAG,KAAG,MAA6B,CAAA;AAE9E;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAG,MAAqC,CAAA;
|
|
1
|
+
{"version":3,"file":"HttpApiSchema.d.ts","sourceRoot":"","sources":["../../src/HttpApiSchema.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAI9C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,GAAG,MAAM,kBAAkB,CAAA;AAGvC;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,OAAO,MAExC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB,EAAE,OAAO,MAAsE,CAAA;AAE5G;;;GAGG;AACH,eAAO,MAAM,yBAAyB,EAAE,OAAO,MAE9C,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB,EAAE,OAAO,MAAwE,CAAA;AAEhH;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE,OAAO,MAEpC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB,QAAS,GAAG,CAAC,WAAW,KAAG,GAAG,CAAC,WAkB7D,CAAA;AAYD;;;GAGG;AACH,eAAO,MAAM,SAAS,QAAS,GAAG,CAAC,GAAG,iBAAiB,MAAM,KAAG,MACD,CAAA;AAE/D;;;GAGG;AACH,eAAO,MAAM,kBAAkB,QAAS,GAAG,CAAC,GAAG,KAAG,OACe,CAAA;AAEjE;;;GAGG;AACH,eAAO,MAAM,YAAY,QAAS,GAAG,CAAC,GAAG,KAAG,OAAoE,CAAA;AAOhH;;;GAGG;AACH,eAAO,MAAM,WAAW,QAAS,GAAG,CAAC,GAAG,KAAG,QAA4E,CAAA;AAEvH;;;GAGG;AACH,eAAO,MAAM,QAAQ,QAAS,GAAG,CAAC,GAAG,KAAG,MAAM,GAAG,SAAmE,CAAA;AAEpH;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,eACd,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG;IACnD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACrC,KACA,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAM7B,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,MAAM,QAAS,GAAG,CAAC,GAAG,KAAG,OAerC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB,QAAS,GAAG,CAAC,GAAG,KAAG,MAAiD,CAAA;AAEpG;;;GAGG;AACH,eAAO,MAAM,gBAAgB,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAG,MAAuC,CAAA;AAE/G;;;GAGG;AACH,eAAO,MAAM,iBAAiB,QAAS,GAAG,CAAC,GAAG,KAAG,MAA6B,CAAA;AAE9E;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAG,MAAqC,CAAA;AAkC3G;;GAEG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAG,MAAM,CAAC,MAAM,CACnH,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,EACrB,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,EAC3B,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CACsB,CAAA;AAEnD,KAAK,KAAK,GAAG,OAAO,MAAM,CAAC,IAAI,CAAA;AAE/B;;;GAGG;AACH,MAAM,WAAW,KAAK,CAAC,IAAI,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,CACrE,SAAQ,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC;IAE5D,QAAQ,CAAC,CAAC,eAAe,CAAC,EAAE,IAAI,CAAA;CACjC;AAED;;;GAGG;AACH,eAAO,MAAM,KAAK,EAAE;IAClB;;;OAGG;IACH,CAAC,IAAI,SAAS,MAAM,EAAE,IAAI,EAAE,IAAI,GAAG,CAAC,CAAC,SAAS,SAAS,EAAE,MAAM,EAAE,CAAC,KAAK,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;IACrF;;;OAGG;IACH,CAAC,IAAI,SAAS,MAAM,EAAE,CAAC,SAAS,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;CAKlF,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,CAAA;AAE3F;;;GAGG;AACH,eAAO,MAAM,KAAK,WAAY,MAAM,KAAG,OAAO,MAAM,CAAC,IAAwD,CAAA;AAE7G;;;GAGG;AACH,MAAM,WAAW,OAAO,CACtB,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,CAC3B,SAAQ,MAAM,CAAC,SAAS,CAAC,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;CAAG;AAEpD;;;GAGG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB;;;OAGG;IACH,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAC1B,OAAO,EAAE;QACP,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;QACvB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;KAChD,GACA,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAA;IAC1B;;;OAGG;IACH,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAC1B,IAAI,EAAE,CAAC,EACP,OAAO,EAAE;QACP,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;QACvB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;KAChD,GACA,OAAO,CAAC,CAAC,CAAC,CAAA;CAqBd,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,OAAQ,SAAQ,KAAK;IACpC,QAAQ,CAAC,CAAC,EAAE,OAAO,MAAM,CAAA;CAC1B;AAED;;;GAGG;AACH,eAAO,MAAM,OAAO,EAAE,OAA2B,CAAA;AAEjD;;;GAGG;AACH,MAAM,WAAW,QAAS,SAAQ,KAAK;IACrC,QAAQ,CAAC,CAAC,EAAE,OAAO,MAAM,CAAA;CAC1B;AAED;;;GAGG;AACH,eAAO,MAAM,QAAQ,EAAE,QAA4B,CAAA;AAEnD;;;GAGG;AACH,MAAM,WAAW,SAAU,SAAQ,KAAK;IACtC,QAAQ,CAAC,CAAC,EAAE,OAAO,MAAM,CAAA;CAC1B;AAED;;;GAGG;AACH,eAAO,MAAM,SAAS,EAAE,SAA6B,CAAA;AAErD;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE,OAAO,MAA+D,CAAA;AAEpG;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,eAAe,CAAA;AAEpD;;;GAGG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,CACpD,SACE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;CACnH;AAEF;;;GAGG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAG,SAAS,CAAC,CAAC,CAGjE,CAAA;AAmBX;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,YAAY,GAAG,MAAM,CAAA;IAC3D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;CAC7B;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC;;;OAGG;IACH,KAAY,QAAQ,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,SAAS,QAAQ,CAAC,MAAM,CAAC,IAAI,IAAI,SAAS,MAAM,GAAG,EAAE,GACvG,IAAI,SAAS,WAAW,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,EAAE,GACnG,8EAA8E,GAChF,IAAI,SAAS,YAAY,GACzB;QAAC,CAAC,CAAC,SAAS,CAAC;KAAC,SAAS,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,uDAAuD,GAClG,IAAI,SAAS,MAAM,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,6CAA6C,GAC1G,KAAK,CAAA;CACV;AAED;;;GAGG;AACH,eAAO,MAAM,YAAY,EAAE;IACzB;;;OAGG;IACH,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,SAAS,QAAQ,CAAC,MAAM,CAAC,EACzD,OAAO,EAAE;QACP,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;QACnB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAC1C,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,GAC7B,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAA;IACjB;;;OAGG;IACH,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,SAAS,QAAQ,CAAC,MAAM,CAAC,EACzD,IAAI,EAAE,CAAC,EACP,OAAO,EAAE;QACP,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;QACnB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAC1C,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,GAC7B,CAAC,CAAA;CAkBM,CAAA;AAEZ;;;GAGG;AACH,eAAO,MAAM,IAAI,aAAc;IAC7B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAC9B,KAAG,OAAO,MAAM,CAAC,MAAmE,CAAA;AAErF;;;GAGG;AACH,eAAO,MAAM,UAAU,aAAc;IACnC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAC9B,KAAG,OAAO,MAAM,CAAC,kBAAiG,CAAA;AAOnH;;GAEG;AACH,eAAO,MAAM,UAAU,YACZ,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,UACvB,MAAM,CAAC,MAAM,CAAC,GAAG,KACxB,IAuBF,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe,CAAC,IAAI,EAAE,GAAG,CAAE,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC;IAC3E,KAAI,CAAC,EAAE,IAAI,GAAG;QAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAA;KAAE,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;CAClE;AAED;;;GAGG;AACH,eAAO,MAAM,UAAU,GAAI,IAAI,cACxB,GAAG,SAAS,MAAM,WAAW;IAClC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAA;IACjB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB,KAAG,eAAe,CAAC,IAAI,EAAE,GAAG,CAqC5B,CAAA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"HttpApiSecurity.d.ts","sourceRoot":"","sources":["../../src/HttpApiSecurity.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AAEzC,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,iBAAiB,CAAA;AAC9D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAE7C;;;GAGG;AACH,eAAO,MAAM,MAAM,EAAE,OAAO,MAAuD,CAAA;AAEnF;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAA;AAElC;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAA;AAErD;;;GAGG;AACH,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC;;;OAGG;IACH,UAAiB,KAAK,CAAC,GAAG,CAAC,CAAC,CAAE,SAAQ,QAAQ;QAC5C,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;YACjB,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;SAC1B,CAAA;QACD,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;KAC7C;IAED;;;OAGG;IACH,KAAY,IAAI,CAAC,CAAC,SAAS,eAAe,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,KAAK,CAAA;CACvF;AAED;;;GAGG;AACH,MAAM,WAAW,MAAO,SAAQ,eAAe,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC7D,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,MAAO,SAAQ,eAAe,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC7D,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB,QAAQ,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAA;IAC1C,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,KAAM,SAAQ,eAAe,CAAC,KAAK,CAAC,WAAW,CAAC;IAC/D,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;CAC5B;AASD;;;;;;;;GAQG;AACH,eAAO,MAAM,MAAM,EAAE,MAGnB,CAAA;AAEF
|
|
1
|
+
{"version":3,"file":"HttpApiSecurity.d.ts","sourceRoot":"","sources":["../../src/HttpApiSecurity.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AAEzC,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,iBAAiB,CAAA;AAC9D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAE7C;;;GAGG;AACH,eAAO,MAAM,MAAM,EAAE,OAAO,MAAuD,CAAA;AAEnF;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAA;AAElC;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAA;AAErD;;;GAGG;AACH,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC;;;OAGG;IACH,UAAiB,KAAK,CAAC,GAAG,CAAC,CAAC,CAAE,SAAQ,QAAQ;QAC5C,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;YACjB,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;SAC1B,CAAA;QACD,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;KAC7C;IAED;;;OAGG;IACH,KAAY,IAAI,CAAC,CAAC,SAAS,eAAe,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,KAAK,CAAA;CACvF;AAED;;;GAGG;AACH,MAAM,WAAW,MAAO,SAAQ,eAAe,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC7D,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,MAAO,SAAQ,eAAe,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC7D,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB,QAAQ,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAA;IAC1C,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,KAAM,SAAQ,eAAe,CAAC,KAAK,CAAC,WAAW,CAAC;IAC/D,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;CAC5B;AASD;;;;;;;;GAQG;AACH,eAAO,MAAM,MAAM,EAAE,MAGnB,CAAA;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,MAAM,YAAa;IAC9B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAA;CACxD,KAAG,MAMA,CAAA;AAEJ;;;GAGG;AACH,eAAO,MAAM,KAAK,EAAE,KAGlB,CAAA;AAEF;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE;IAC5B;;;OAGG;IACH,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,eAAe,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,CAAA;IAC3E;;;OAGG;IACH,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;CAQxE,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB;;;OAGG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,SAAS,eAAe,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,CAAA;IACnF;;;OAGG;IACH,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAAA;CAQhF,CAAA"}
|
package/dist/dts/OpenApi.d.ts
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* @since 1.0.0
|
|
3
3
|
*/
|
|
4
|
+
import type { NonEmptyArray } from "effect/Array";
|
|
4
5
|
import * as Context from "effect/Context";
|
|
5
|
-
import type { ReadonlyRecord } from "effect/Record";
|
|
6
6
|
import * as HttpApi from "./HttpApi.js";
|
|
7
|
+
import type { HttpApiGroup } from "./HttpApiGroup.js";
|
|
7
8
|
import * as JsonSchema from "./OpenApiJsonSchema.js";
|
|
8
9
|
declare const Identifier_base: Context.TagClass<Identifier, "@effect/platform/OpenApi/Identifier", string>;
|
|
9
10
|
/**
|
|
@@ -108,6 +109,7 @@ export declare const annotations: (options: {
|
|
|
108
109
|
readonly description?: string | undefined;
|
|
109
110
|
readonly license?: OpenAPISpecLicense | undefined;
|
|
110
111
|
readonly summary?: string | undefined;
|
|
112
|
+
readonly deprecated?: boolean | undefined;
|
|
111
113
|
readonly externalDocs?: OpenAPISpecExternalDocs | undefined;
|
|
112
114
|
readonly servers?: ReadonlyArray<OpenAPISpecServer> | undefined;
|
|
113
115
|
readonly format?: string | undefined;
|
|
@@ -116,83 +118,120 @@ export declare const annotations: (options: {
|
|
|
116
118
|
readonly transform?: ((openApiSpec: Record<string, any>) => Record<string, any>) | undefined;
|
|
117
119
|
}) => Context.Context<never>;
|
|
118
120
|
/**
|
|
121
|
+
* Converts an `HttpApi` instance into an OpenAPI Specification object.
|
|
122
|
+
*
|
|
123
|
+
* **Details**
|
|
124
|
+
*
|
|
125
|
+
* This function takes an `HttpApi` instance, which defines a structured API,
|
|
126
|
+
* and generates an OpenAPI Specification (`OpenAPISpec`). The resulting spec
|
|
127
|
+
* adheres to the OpenAPI 3.1.0 standard and includes detailed metadata such as
|
|
128
|
+
* paths, operations, security schemes, and components. The function processes
|
|
129
|
+
* the API's annotations, middleware, groups, and endpoints to build a complete
|
|
130
|
+
* and accurate representation of the API in OpenAPI format.
|
|
131
|
+
*
|
|
132
|
+
* The function also deduplicates schemas, applies transformations, and
|
|
133
|
+
* integrates annotations like descriptions, summaries, external documentation,
|
|
134
|
+
* and overrides. Cached results are used for better performance when the same
|
|
135
|
+
* `HttpApi` instance is processed multiple times.
|
|
136
|
+
*
|
|
137
|
+
* @example
|
|
138
|
+
* ```ts
|
|
139
|
+
* import { HttpApi, HttpApiEndpoint, HttpApiGroup, OpenApi } from "@effect/platform"
|
|
140
|
+
* import { Schema } from "effect"
|
|
141
|
+
*
|
|
142
|
+
* const api = HttpApi.make("api").add(
|
|
143
|
+
* HttpApiGroup.make("group").add(
|
|
144
|
+
* HttpApiEndpoint.get("get", "/items")
|
|
145
|
+
* .addSuccess(Schema.Array(Schema.String))
|
|
146
|
+
* )
|
|
147
|
+
* )
|
|
148
|
+
*
|
|
149
|
+
* const spec = OpenApi.fromApi(api)
|
|
150
|
+
*
|
|
151
|
+
* // console.log(JSON.stringify(spec, null, 2))
|
|
152
|
+
* // Output: OpenAPI specification in JSON format
|
|
153
|
+
* ```
|
|
154
|
+
*
|
|
119
155
|
* @category constructors
|
|
120
156
|
* @since 1.0.0
|
|
121
157
|
*/
|
|
122
|
-
export declare const fromApi: <
|
|
158
|
+
export declare const fromApi: <Id extends string, Groups extends HttpApiGroup.Any, E, R>(api: HttpApi.HttpApi<Id, Groups, E, R>) => OpenAPISpec;
|
|
123
159
|
/**
|
|
160
|
+
* This model describes the OpenAPI specification (version 3.1.0) returned by
|
|
161
|
+
* {@link fromApi}. It is not intended to describe the entire OpenAPI
|
|
162
|
+
* specification, only the output of `fromApi`.
|
|
163
|
+
*
|
|
124
164
|
* @category models
|
|
125
165
|
* @since 1.0.0
|
|
126
166
|
*/
|
|
127
167
|
export interface OpenAPISpec {
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
readonly externalDocs?: OpenAPISpecExternalDocs;
|
|
168
|
+
openapi: "3.1.0";
|
|
169
|
+
info: OpenAPISpecInfo;
|
|
170
|
+
paths: OpenAPISpecPaths;
|
|
171
|
+
components: OpenAPIComponents;
|
|
172
|
+
security: Array<OpenAPISecurityRequirement>;
|
|
173
|
+
tags: Array<OpenAPISpecTag>;
|
|
174
|
+
servers?: Array<OpenAPISpecServer>;
|
|
136
175
|
}
|
|
137
176
|
/**
|
|
138
177
|
* @category models
|
|
139
178
|
* @since 1.0.0
|
|
140
179
|
*/
|
|
141
180
|
export interface OpenAPISpecInfo {
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
181
|
+
title: string;
|
|
182
|
+
version: string;
|
|
183
|
+
description?: string;
|
|
184
|
+
license?: OpenAPISpecLicense;
|
|
185
|
+
summary?: string;
|
|
147
186
|
}
|
|
148
187
|
/**
|
|
149
188
|
* @category models
|
|
150
189
|
* @since 1.0.0
|
|
151
190
|
*/
|
|
152
191
|
export interface OpenAPISpecTag {
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
192
|
+
name: string;
|
|
193
|
+
description?: string;
|
|
194
|
+
externalDocs?: OpenAPISpecExternalDocs;
|
|
156
195
|
}
|
|
157
196
|
/**
|
|
158
197
|
* @category models
|
|
159
198
|
* @since 1.0.0
|
|
160
199
|
*/
|
|
161
200
|
export interface OpenAPISpecExternalDocs {
|
|
162
|
-
|
|
163
|
-
|
|
201
|
+
url: string;
|
|
202
|
+
description?: string;
|
|
164
203
|
}
|
|
165
204
|
/**
|
|
166
205
|
* @category models
|
|
167
206
|
* @since 1.0.0
|
|
168
207
|
*/
|
|
169
208
|
export interface OpenAPISpecLicense {
|
|
170
|
-
|
|
171
|
-
|
|
209
|
+
name: string;
|
|
210
|
+
url?: string;
|
|
172
211
|
}
|
|
173
212
|
/**
|
|
174
213
|
* @category models
|
|
175
214
|
* @since 1.0.0
|
|
176
215
|
*/
|
|
177
216
|
export interface OpenAPISpecServer {
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
217
|
+
url: string;
|
|
218
|
+
description?: string;
|
|
219
|
+
variables?: Record<string, OpenAPISpecServerVariable>;
|
|
181
220
|
}
|
|
182
221
|
/**
|
|
183
222
|
* @category models
|
|
184
223
|
* @since 1.0.0
|
|
185
224
|
*/
|
|
186
225
|
export interface OpenAPISpecServerVariable {
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
226
|
+
default: string;
|
|
227
|
+
enum?: NonEmptyArray<string>;
|
|
228
|
+
description?: string;
|
|
190
229
|
}
|
|
191
230
|
/**
|
|
192
231
|
* @category models
|
|
193
232
|
* @since 1.0.0
|
|
194
233
|
*/
|
|
195
|
-
export type OpenAPISpecPaths =
|
|
234
|
+
export type OpenAPISpecPaths = Record<string, OpenAPISpecPathItem>;
|
|
196
235
|
/**
|
|
197
236
|
* @category models
|
|
198
237
|
* @since 1.0.0
|
|
@@ -203,24 +242,18 @@ export type OpenAPISpecMethodName = "get" | "put" | "post" | "delete" | "options
|
|
|
203
242
|
* @since 1.0.0
|
|
204
243
|
*/
|
|
205
244
|
export type OpenAPISpecPathItem = {
|
|
206
|
-
|
|
207
|
-
} & {
|
|
208
|
-
readonly summary?: string;
|
|
209
|
-
readonly description?: string;
|
|
210
|
-
readonly parameters?: Array<OpenAPISpecParameter>;
|
|
245
|
+
[K in OpenAPISpecMethodName]?: OpenAPISpecOperation;
|
|
211
246
|
};
|
|
212
247
|
/**
|
|
213
248
|
* @category models
|
|
214
249
|
* @since 1.0.0
|
|
215
250
|
*/
|
|
216
251
|
export interface OpenAPISpecParameter {
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
readonly deprecated?: boolean;
|
|
223
|
-
readonly allowEmptyValue?: boolean;
|
|
252
|
+
name: string;
|
|
253
|
+
in: "query" | "header" | "path" | "cookie";
|
|
254
|
+
schema: JsonSchema.JsonSchema;
|
|
255
|
+
required: boolean;
|
|
256
|
+
description?: string;
|
|
224
257
|
}
|
|
225
258
|
/**
|
|
226
259
|
* @category models
|
|
@@ -231,61 +264,44 @@ export type OpenAPISpecResponses = Record<number, OpenApiSpecResponse>;
|
|
|
231
264
|
* @category models
|
|
232
265
|
* @since 1.0.0
|
|
233
266
|
*/
|
|
234
|
-
export type OpenApiSpecContentType = "application/json" | "application/xml" | "multipart/form-data" | "text/plain";
|
|
267
|
+
export type OpenApiSpecContentType = "application/json" | "application/xml" | "application/x-www-form-urlencoded" | "multipart/form-data" | "text/plain";
|
|
235
268
|
/**
|
|
236
269
|
* @category models
|
|
237
270
|
* @since 1.0.0
|
|
238
271
|
*/
|
|
239
272
|
export type OpenApiSpecContent = {
|
|
240
|
-
|
|
273
|
+
[K in OpenApiSpecContentType]?: OpenApiSpecMediaType;
|
|
241
274
|
};
|
|
242
|
-
/**
|
|
243
|
-
* @category models
|
|
244
|
-
* @since 1.0.0
|
|
245
|
-
*/
|
|
246
|
-
export interface OpenApiSpecResponseHeader {
|
|
247
|
-
readonly description?: string;
|
|
248
|
-
readonly schema: JsonSchema.JsonSchema;
|
|
249
|
-
}
|
|
250
|
-
/**
|
|
251
|
-
* @category models
|
|
252
|
-
* @since 1.0.0
|
|
253
|
-
*/
|
|
254
|
-
export type OpenApiSpecResponseHeaders = ReadonlyRecord<string, OpenApiSpecResponseHeader>;
|
|
255
275
|
/**
|
|
256
276
|
* @category models
|
|
257
277
|
* @since 1.0.0
|
|
258
278
|
*/
|
|
259
279
|
export interface OpenApiSpecResponse {
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
readonly description: string;
|
|
280
|
+
description: string;
|
|
281
|
+
content?: OpenApiSpecContent;
|
|
263
282
|
}
|
|
264
283
|
/**
|
|
265
284
|
* @category models
|
|
266
285
|
* @since 1.0.0
|
|
267
286
|
*/
|
|
268
287
|
export interface OpenApiSpecMediaType {
|
|
269
|
-
|
|
270
|
-
readonly example?: object;
|
|
271
|
-
readonly description?: string;
|
|
288
|
+
schema: JsonSchema.JsonSchema;
|
|
272
289
|
}
|
|
273
290
|
/**
|
|
274
291
|
* @category models
|
|
275
292
|
* @since 1.0.0
|
|
276
293
|
*/
|
|
277
294
|
export interface OpenAPISpecRequestBody {
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
readonly required?: boolean;
|
|
295
|
+
content: OpenApiSpecContent;
|
|
296
|
+
required: true;
|
|
281
297
|
}
|
|
282
298
|
/**
|
|
283
299
|
* @category models
|
|
284
300
|
* @since 1.0.0
|
|
285
301
|
*/
|
|
286
302
|
export interface OpenAPIComponents {
|
|
287
|
-
|
|
288
|
-
|
|
303
|
+
schemas: Record<string, JsonSchema.JsonSchema>;
|
|
304
|
+
securitySchemes: Record<string, OpenAPISecurityScheme>;
|
|
289
305
|
}
|
|
290
306
|
/**
|
|
291
307
|
* @category models
|
|
@@ -293,9 +309,9 @@ export interface OpenAPIComponents {
|
|
|
293
309
|
*/
|
|
294
310
|
export interface OpenAPIHTTPSecurityScheme {
|
|
295
311
|
readonly type: "http";
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
312
|
+
scheme: "bearer" | "basic" | string;
|
|
313
|
+
description?: string;
|
|
314
|
+
bearerFormat?: string;
|
|
299
315
|
}
|
|
300
316
|
/**
|
|
301
317
|
* @category models
|
|
@@ -303,61 +319,36 @@ export interface OpenAPIHTTPSecurityScheme {
|
|
|
303
319
|
*/
|
|
304
320
|
export interface OpenAPIApiKeySecurityScheme {
|
|
305
321
|
readonly type: "apiKey";
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
}
|
|
310
|
-
/**
|
|
311
|
-
* @category models
|
|
312
|
-
* @since 1.0.0
|
|
313
|
-
*/
|
|
314
|
-
export interface OpenAPIMutualTLSSecurityScheme {
|
|
315
|
-
readonly type: "mutualTLS";
|
|
316
|
-
readonly description?: string;
|
|
317
|
-
}
|
|
318
|
-
/**
|
|
319
|
-
* @category models
|
|
320
|
-
* @since 1.0.0
|
|
321
|
-
*/
|
|
322
|
-
export interface OpenAPIOAuth2SecurityScheme {
|
|
323
|
-
readonly type: "oauth2";
|
|
324
|
-
readonly description?: string;
|
|
325
|
-
readonly flows: ReadonlyRecord<"implicit" | "password" | "clientCredentials" | "authorizationCode", ReadonlyRecord<string, unknown>>;
|
|
326
|
-
}
|
|
327
|
-
/**
|
|
328
|
-
* @category models
|
|
329
|
-
* @since 1.0.0
|
|
330
|
-
*/
|
|
331
|
-
export interface OpenAPIOpenIdConnectSecurityScheme {
|
|
332
|
-
readonly type: "openIdConnect";
|
|
333
|
-
readonly description?: string;
|
|
334
|
-
readonly openIdConnectUrl: string;
|
|
322
|
+
name: string;
|
|
323
|
+
in: "query" | "header" | "cookie";
|
|
324
|
+
description?: string;
|
|
335
325
|
}
|
|
336
326
|
/**
|
|
337
327
|
* @category models
|
|
338
328
|
* @since 1.0.0
|
|
339
329
|
*/
|
|
340
|
-
export type OpenAPISecurityScheme = OpenAPIHTTPSecurityScheme | OpenAPIApiKeySecurityScheme
|
|
330
|
+
export type OpenAPISecurityScheme = OpenAPIHTTPSecurityScheme | OpenAPIApiKeySecurityScheme;
|
|
341
331
|
/**
|
|
342
332
|
* @category models
|
|
343
333
|
* @since 1.0.0
|
|
344
334
|
*/
|
|
345
|
-
export type OpenAPISecurityRequirement =
|
|
335
|
+
export type OpenAPISecurityRequirement = Record<string, Array<string>>;
|
|
346
336
|
/**
|
|
347
337
|
* @category models
|
|
348
338
|
* @since 1.0.0
|
|
349
339
|
*/
|
|
350
340
|
export interface OpenAPISpecOperation {
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
341
|
+
operationId: string;
|
|
342
|
+
parameters: Array<OpenAPISpecParameter>;
|
|
343
|
+
responses: OpenAPISpecResponses;
|
|
344
|
+
/** Always contains at least the title annotation or the group identifier */
|
|
345
|
+
tags: NonEmptyArray<string>;
|
|
346
|
+
security: Array<OpenAPISecurityRequirement>;
|
|
347
|
+
requestBody?: OpenAPISpecRequestBody;
|
|
348
|
+
description?: string;
|
|
349
|
+
summary?: string;
|
|
350
|
+
deprecated?: boolean;
|
|
351
|
+
externalDocs?: OpenAPISpecExternalDocs;
|
|
361
352
|
}
|
|
362
353
|
export {};
|
|
363
354
|
//# sourceMappingURL=OpenApi.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OpenApi.d.ts","sourceRoot":"","sources":["../../src/OpenApi.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"OpenApi.d.ts","sourceRoot":"","sources":["../../src/OpenApi.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AAMzC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAKrD,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAA;;AAEpD;;;GAGG;AACH,qBAAa,UAAW,SAAQ,eAAwE;CAAG;;AAE3G;;;GAGG;AACH,qBAAa,KAAM,SAAQ,UAA8D;CAAG;;AAE5F;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAAkE;CAAG;;AAElG;;;GAGG;AACH,qBAAa,WAAY,SAAQ,gBAA0E;CAAG;;AAE9G;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAA8E;CAAG;;AAE9G;;;GAGG;AACH,qBAAa,YACX,SAAQ,iBAA6F;CACrG;;AAEF;;;GAGG;AACH,qBAAa,OACX,SAAQ,YAA4F;CACpG;;AAEF;;;GAGG;AACH,qBAAa,MAAO,SAAQ,WAAgE;CAAG;;AAE/F;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAAkE;CAAG;;AAElG;;;GAGG;AACH,qBAAa,UAAW,SAAQ,eAAyE;CAAG;;AAE5G;;;GAGG;AACH,qBAAa,QAAS,SAAQ,aAAqF;CAAG;;AAEtH;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAE3B;CAAG;8GASW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;AAP3D;;;;GAIG;AACH,qBAAa,SAAU,SAAQ,cAG5B;CAAG;AAmBN;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,CACxB,OAAO,EAAE;IACP,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACxC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACnC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAA;IACjD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,YAAY,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAA;IAC3D,QAAQ,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAA;IAC/D,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACpC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACvD,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACtC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,SAAS,CAAA;CAC7F,KACE,OAAO,CAAC,OAAO,CAAC,KAAK,CAcxB,CAAA;AAoBF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,eAAO,MAAM,OAAO,GAAI,EAAE,SAAS,MAAM,EAAE,MAAM,SAAS,YAAY,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,OACzE,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,KACrC,WAuNF,CAAA;AAsCD;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,eAAe,CAAA;IACrB,KAAK,EAAE,gBAAgB,CAAA;IACvB,UAAU,EAAE,iBAAiB,CAAA;IAC7B,QAAQ,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAA;IAC3C,IAAI,EAAE,KAAK,CAAC,cAAc,CAAC,CAAA;IAC3B,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAA;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,kBAAkB,CAAA;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,uBAAuB,CAAA;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAA;CACtD;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAA;AAElE;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAC7B,KAAK,GACL,KAAK,GACL,MAAM,GACN,QAAQ,GACR,SAAS,GACT,MAAM,GACN,OAAO,GACP,OAAO,CAAA;AAEX;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;KAC/B,CAAC,IAAI,qBAAqB,CAAC,CAAC,EAAE,oBAAoB;CACpD,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAA;IAC1C,MAAM,EAAE,UAAU,CAAC,UAAU,CAAA;IAC7B,QAAQ,EAAE,OAAO,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAA;AAEtE;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAC9B,kBAAkB,GAClB,iBAAiB,GACjB,mCAAmC,GACnC,qBAAqB,GACrB,YAAY,CAAA;AAEhB;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;KAC9B,CAAC,IAAI,sBAAsB,CAAC,CAAC,EAAE,oBAAoB;CACrD,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,kBAAkB,CAAA;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,UAAU,CAAC,UAAU,CAAA;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,kBAAkB,CAAA;IAC3B,QAAQ,EAAE,IAAI,CAAA;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;IAC9C,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;CACvD;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAA;IACnC,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;IACjC,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAC7B,yBAAyB,GACzB,2BAA2B,CAAA;AAE/B;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;AAEtE;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAA;IACvC,SAAS,EAAE,oBAAoB,CAAA;IAC/B,4EAA4E;IAC5E,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAC3B,QAAQ,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAA;IAC3C,WAAW,CAAC,EAAE,sBAAsB,CAAA;IACpC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,YAAY,CAAC,EAAE,uBAAuB,CAAA;CACvC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OpenApiJsonSchema.d.ts","sourceRoot":"","sources":["../../src/OpenApiJsonSchema.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAA;
|
|
1
|
+
{"version":3,"file":"OpenApiJsonSchema.d.ts","sourceRoot":"","sources":["../../src/OpenApiJsonSchema.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAA;AAG5C;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,QAAQ,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;CACrC;AAED;;;GAGG;AACH,MAAM,WAAW,KAAM,SAAQ,WAAW;IACxC,GAAG,EAAE,gBAAgB,CAAA;IACrB,GAAG,EAAE,EAAE,CAAA;IACP,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,GAAI,SAAQ,WAAW;IACtC,GAAG,EAAE,cAAc,CAAA;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAQ,SAAQ,WAAW;IAC1C,GAAG,EAAE,kBAAkB,CAAA;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,GAAG,EAAE,eAAe,CAAA;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,SAAU,SAAQ,WAAW;IAC5C,GAAG,EAAE,iBAAiB,CAAA;IACtB,KAAK,EAAE;QACL;YAAE,IAAI,EAAE,QAAQ,CAAA;SAAE;QAClB;YAAE,IAAI,EAAE,OAAO,CAAA;SAAE;KAClB,CAAA;IACD,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,KAAM,SAAQ,WAAW;IACxC,GAAG,EAAE,aAAa,CAAA;IAClB,KAAK,EAAE;QACL;YAAE,IAAI,EAAE,QAAQ,CAAA;SAAE;QAClB;YAAE,IAAI,EAAE,OAAO,CAAA;SAAE;KAClB,CAAA;IACD,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,GAAI,SAAQ,WAAW;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,MAAO,SAAQ,WAAW;IACzC,IAAI,EAAE,QAAQ,CAAA;IACd,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,aAAa,CAAC,EAAE,UAAU,CAAA;IAC1B,KAAK,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC;QACvB,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,CAAC,CAAA;IACF,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAQ,SAAQ,WAAW;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC;QACvB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,gBAAgB,CAAC,EAAE,MAAM,CAAA;QACzB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,gBAAgB,CAAC,EAAE,MAAM,CAAA;QACzB,UAAU,CAAC,EAAE,MAAM,CAAA;KACpB,CAAC,CAAA;IACF,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,MAAO,SAAQ,OAAO;IACrC,IAAI,EAAE,QAAQ,CAAA;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,OAAQ,SAAQ,OAAO;IACtC,IAAI,EAAE,SAAS,CAAA;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAQ,SAAQ,WAAW;IAC1C,IAAI,EAAE,SAAS,CAAA;IACf,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,KAAM,SAAQ,WAAW;IACxC,IAAI,EAAE,OAAO,CAAA;IACb,KAAK,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;IACjD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,eAAe,CAAC,EAAE,UAAU,GAAG,OAAO,CAAA;IACtC,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAA;IACtC,IAAI,EAAE,UAAU,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC,CAAA;IACxD,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,KAAM,SAAQ,WAAW;IACxC,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC;QACtB,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAA;QACzB,KAAK,EAAE,MAAM,CAAA;QACb,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,CAAA;KACxB,CAAC,CAAA;IACF,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,KAAM,SAAQ,WAAW;IACxC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;IACnC,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,MAAO,SAAQ,WAAW;IACzC,IAAI,EAAE,QAAQ,CAAA;IACd,QAAQ,EAAE,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IAClC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IACtC,oBAAoB,CAAC,EAAE,OAAO,GAAG,UAAU,CAAA;IAC3C,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IAC9C,aAAa,CAAC,EAAE,UAAU,CAAA;IAC1B,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAClB,KAAK,GACL,GAAG,GACH,OAAO,GACP,IAAI,GACJ,SAAS,GACT,KAAK,GACL,GAAG,GACH,MAAM,GACN,MAAM,GACN,OAAO,GACP,OAAO,GACP,KAAK,GACL,IAAI,GACJ,KAAK,GACL,KAAK,GACL,MAAM,CAAA;AAEV;;;GAGG;AACH,MAAM,MAAM,IAAI,GAAG,UAAU,GAAG;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;CACnC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAG,IAO9D,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,WAAW;IAC7E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAClC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,yBAAyB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CACrD,KAAG,UAA0C,CAAA"}
|
package/dist/dts/Runtime.d.ts
CHANGED
|
@@ -18,11 +18,59 @@ export declare const defaultTeardown: Teardown;
|
|
|
18
18
|
* @since 1.0.0
|
|
19
19
|
*/
|
|
20
20
|
export interface RunMain {
|
|
21
|
+
/**
|
|
22
|
+
* Helps you run a main effect with built-in error handling, logging, and signal management.
|
|
23
|
+
*
|
|
24
|
+
* **Details**
|
|
25
|
+
*
|
|
26
|
+
* This function launches an Effect as the main entry point, setting exit codes
|
|
27
|
+
* based on success or failure, handling interrupts (e.g., Ctrl+C), and optionally
|
|
28
|
+
* logging errors. By default, it logs errors and uses a "pretty" format, but both
|
|
29
|
+
* behaviors can be turned off. You can also provide custom teardown logic to
|
|
30
|
+
* finalize resources or produce different exit codes.
|
|
31
|
+
*
|
|
32
|
+
* **Options**
|
|
33
|
+
*
|
|
34
|
+
* An optional object that can include:
|
|
35
|
+
* - `disableErrorReporting`: Turn off automatic error logging.
|
|
36
|
+
* - `disablePrettyLogger`: Avoid adding the pretty logger.
|
|
37
|
+
* - `teardown`: Provide custom finalization logic.
|
|
38
|
+
*
|
|
39
|
+
* **When to Use**
|
|
40
|
+
*
|
|
41
|
+
* Use this function to run an Effect as your application’s main program, especially
|
|
42
|
+
* when you need structured error handling, log management, interrupt support,
|
|
43
|
+
* or advanced teardown capabilities.
|
|
44
|
+
*/
|
|
21
45
|
(options?: {
|
|
22
46
|
readonly disableErrorReporting?: boolean | undefined;
|
|
23
47
|
readonly disablePrettyLogger?: boolean | undefined;
|
|
24
48
|
readonly teardown?: Teardown | undefined;
|
|
25
49
|
}): <E, A>(effect: Effect.Effect<A, E>) => void;
|
|
50
|
+
/**
|
|
51
|
+
* Helps you run a main effect with built-in error handling, logging, and signal management.
|
|
52
|
+
*
|
|
53
|
+
* **Details**
|
|
54
|
+
*
|
|
55
|
+
* This function launches an Effect as the main entry point, setting exit codes
|
|
56
|
+
* based on success or failure, handling interrupts (e.g., Ctrl+C), and optionally
|
|
57
|
+
* logging errors. By default, it logs errors and uses a "pretty" format, but both
|
|
58
|
+
* behaviors can be turned off. You can also provide custom teardown logic to
|
|
59
|
+
* finalize resources or produce different exit codes.
|
|
60
|
+
*
|
|
61
|
+
* **Options**
|
|
62
|
+
*
|
|
63
|
+
* An optional object that can include:
|
|
64
|
+
* - `disableErrorReporting`: Turn off automatic error logging.
|
|
65
|
+
* - `disablePrettyLogger`: Avoid adding the pretty logger.
|
|
66
|
+
* - `teardown`: Provide custom finalization logic.
|
|
67
|
+
*
|
|
68
|
+
* **When to Use**
|
|
69
|
+
*
|
|
70
|
+
* Use this function to run an Effect as your application’s main program, especially
|
|
71
|
+
* when you need structured error handling, log management, interrupt support,
|
|
72
|
+
* or advanced teardown capabilities.
|
|
73
|
+
*/
|
|
26
74
|
<E, A>(effect: Effect.Effect<A, E>, options?: {
|
|
27
75
|
readonly disableErrorReporting?: boolean | undefined;
|
|
28
76
|
readonly disablePrettyLogger?: boolean | undefined;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Runtime.d.ts","sourceRoot":"","sources":["../../src/Runtime.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,IAAI,MAAM,aAAa,CAAA;AACnC,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAA;AAQ1C;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAAA;CACpE;AAED;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE,QAK7B,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,CACE,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACpD,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QAClD,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;KACzC,GACA,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAA;IAC9C,CAAC,CAAC,EAAE,CAAC,EACH,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAC3B,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACpD,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QAClD,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;KACzC,GACA,IAAI,CAAA;CACR;AAiBD;;;GAGG;AACH,eAAO,MAAM,WAAW,MACnB,CAAC,CAAC,EAAE,CAAC,EACN,OAAO,EAAE;IACP,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IACxC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;CAC5B,KACE,IAAI,KACR,OAuBC,CAAA"}
|
|
1
|
+
{"version":3,"file":"Runtime.d.ts","sourceRoot":"","sources":["../../src/Runtime.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,IAAI,MAAM,aAAa,CAAA;AACnC,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAA;AAQ1C;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAAA;CACpE;AAED;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE,QAK7B,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,CACE,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACpD,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QAClD,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;KACzC,GACA,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAA;IAC9C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,CAAC,CAAC,EAAE,CAAC,EACH,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAC3B,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACpD,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QAClD,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;KACzC,GACA,IAAI,CAAA;CACR;AAiBD;;;GAGG;AACH,eAAO,MAAM,WAAW,MACnB,CAAC,CAAC,EAAE,CAAC,EACN,OAAO,EAAE;IACP,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IACxC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;CAC5B,KACE,IAAI,KACR,OAuBC,CAAA"}
|