@alma-cdk/construct-library 0.0.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/.jsii +9041 -0
- package/.nvmrc +1 -0
- package/API.md +1812 -0
- package/LICENSE +202 -0
- package/README.md +1 -0
- package/lib/AlmaCdkConstructLibrary.d.ts +7 -0
- package/lib/AlmaCdkConstructLibrary.js +101 -0
- package/lib/NodeConfig.d.ts +10 -0
- package/lib/NodeConfig.js +33 -0
- package/lib/SonarCloudReportWorkflow.d.ts +4 -0
- package/lib/SonarCloudReportWorkflow.js +64 -0
- package/lib/index.d.ts +1 -0
- package/lib/index.js +6 -0
- package/lib/schemas/almaCdkConstructLibraryOptions.d.ts +58 -0
- package/lib/schemas/almaCdkConstructLibraryOptions.js +62 -0
- package/lib/schemas/name.d.ts +11 -0
- package/lib/schemas/name.js +22 -0
- package/lib/schemas/repositoryUrl.d.ts +3 -0
- package/lib/schemas/repositoryUrl.js +12 -0
- package/node_modules/semver/LICENSE +15 -0
- package/node_modules/semver/README.md +665 -0
- package/node_modules/semver/bin/semver.js +191 -0
- package/node_modules/semver/classes/comparator.js +143 -0
- package/node_modules/semver/classes/index.js +7 -0
- package/node_modules/semver/classes/range.js +557 -0
- package/node_modules/semver/classes/semver.js +333 -0
- package/node_modules/semver/functions/clean.js +8 -0
- package/node_modules/semver/functions/cmp.js +54 -0
- package/node_modules/semver/functions/coerce.js +62 -0
- package/node_modules/semver/functions/compare-build.js +9 -0
- package/node_modules/semver/functions/compare-loose.js +5 -0
- package/node_modules/semver/functions/compare.js +7 -0
- package/node_modules/semver/functions/diff.js +60 -0
- package/node_modules/semver/functions/eq.js +5 -0
- package/node_modules/semver/functions/gt.js +5 -0
- package/node_modules/semver/functions/gte.js +5 -0
- package/node_modules/semver/functions/inc.js +21 -0
- package/node_modules/semver/functions/lt.js +5 -0
- package/node_modules/semver/functions/lte.js +5 -0
- package/node_modules/semver/functions/major.js +5 -0
- package/node_modules/semver/functions/minor.js +5 -0
- package/node_modules/semver/functions/neq.js +5 -0
- package/node_modules/semver/functions/parse.js +18 -0
- package/node_modules/semver/functions/patch.js +5 -0
- package/node_modules/semver/functions/prerelease.js +8 -0
- package/node_modules/semver/functions/rcompare.js +5 -0
- package/node_modules/semver/functions/rsort.js +5 -0
- package/node_modules/semver/functions/satisfies.js +12 -0
- package/node_modules/semver/functions/sort.js +5 -0
- package/node_modules/semver/functions/valid.js +8 -0
- package/node_modules/semver/index.js +91 -0
- package/node_modules/semver/internal/constants.js +37 -0
- package/node_modules/semver/internal/debug.js +11 -0
- package/node_modules/semver/internal/identifiers.js +29 -0
- package/node_modules/semver/internal/lrucache.js +42 -0
- package/node_modules/semver/internal/parse-options.js +17 -0
- package/node_modules/semver/internal/re.js +223 -0
- package/node_modules/semver/node_modules/.bin/semver +21 -0
- package/node_modules/semver/package.json +78 -0
- package/node_modules/semver/preload.js +4 -0
- package/node_modules/semver/range.bnf +16 -0
- package/node_modules/semver/ranges/gtr.js +6 -0
- package/node_modules/semver/ranges/intersects.js +9 -0
- package/node_modules/semver/ranges/ltr.js +6 -0
- package/node_modules/semver/ranges/max-satisfying.js +27 -0
- package/node_modules/semver/ranges/min-satisfying.js +26 -0
- package/node_modules/semver/ranges/min-version.js +63 -0
- package/node_modules/semver/ranges/outside.js +82 -0
- package/node_modules/semver/ranges/simplify.js +49 -0
- package/node_modules/semver/ranges/subset.js +249 -0
- package/node_modules/semver/ranges/to-comparators.js +10 -0
- package/node_modules/semver/ranges/valid.js +13 -0
- package/node_modules/zod/LICENSE +21 -0
- package/node_modules/zod/README.md +208 -0
- package/node_modules/zod/index.cjs +33 -0
- package/node_modules/zod/index.d.cts +4 -0
- package/node_modules/zod/index.d.ts +4 -0
- package/node_modules/zod/index.js +4 -0
- package/node_modules/zod/locales/index.cjs +17 -0
- package/node_modules/zod/locales/index.d.cts +1 -0
- package/node_modules/zod/locales/index.d.ts +1 -0
- package/node_modules/zod/locales/index.js +1 -0
- package/node_modules/zod/locales/package.json +6 -0
- package/node_modules/zod/mini/index.cjs +32 -0
- package/node_modules/zod/mini/index.d.cts +3 -0
- package/node_modules/zod/mini/index.d.ts +3 -0
- package/node_modules/zod/mini/index.js +3 -0
- package/node_modules/zod/mini/package.json +6 -0
- package/node_modules/zod/package.json +135 -0
- package/node_modules/zod/src/index.ts +4 -0
- package/node_modules/zod/src/locales/index.ts +1 -0
- package/node_modules/zod/src/mini/index.ts +3 -0
- package/node_modules/zod/src/v3/ZodError.ts +330 -0
- package/node_modules/zod/src/v3/benchmarks/datetime.ts +58 -0
- package/node_modules/zod/src/v3/benchmarks/discriminatedUnion.ts +80 -0
- package/node_modules/zod/src/v3/benchmarks/index.ts +59 -0
- package/node_modules/zod/src/v3/benchmarks/ipv4.ts +57 -0
- package/node_modules/zod/src/v3/benchmarks/object.ts +69 -0
- package/node_modules/zod/src/v3/benchmarks/primitives.ts +162 -0
- package/node_modules/zod/src/v3/benchmarks/realworld.ts +63 -0
- package/node_modules/zod/src/v3/benchmarks/string.ts +55 -0
- package/node_modules/zod/src/v3/benchmarks/union.ts +80 -0
- package/node_modules/zod/src/v3/errors.ts +13 -0
- package/node_modules/zod/src/v3/external.ts +6 -0
- package/node_modules/zod/src/v3/helpers/enumUtil.ts +17 -0
- package/node_modules/zod/src/v3/helpers/errorUtil.ts +8 -0
- package/node_modules/zod/src/v3/helpers/parseUtil.ts +176 -0
- package/node_modules/zod/src/v3/helpers/partialUtil.ts +34 -0
- package/node_modules/zod/src/v3/helpers/typeAliases.ts +2 -0
- package/node_modules/zod/src/v3/helpers/util.ts +224 -0
- package/node_modules/zod/src/v3/index.ts +4 -0
- package/node_modules/zod/src/v3/locales/en.ts +124 -0
- package/node_modules/zod/src/v3/standard-schema.ts +113 -0
- package/node_modules/zod/src/v3/tests/Mocker.ts +54 -0
- package/node_modules/zod/src/v3/tests/all-errors.test.ts +157 -0
- package/node_modules/zod/src/v3/tests/anyunknown.test.ts +28 -0
- package/node_modules/zod/src/v3/tests/array.test.ts +71 -0
- package/node_modules/zod/src/v3/tests/async-parsing.test.ts +388 -0
- package/node_modules/zod/src/v3/tests/async-refinements.test.ts +46 -0
- package/node_modules/zod/src/v3/tests/base.test.ts +29 -0
- package/node_modules/zod/src/v3/tests/bigint.test.ts +55 -0
- package/node_modules/zod/src/v3/tests/branded.test.ts +53 -0
- package/node_modules/zod/src/v3/tests/catch.test.ts +220 -0
- package/node_modules/zod/src/v3/tests/coerce.test.ts +133 -0
- package/node_modules/zod/src/v3/tests/complex.test.ts +70 -0
- package/node_modules/zod/src/v3/tests/custom.test.ts +31 -0
- package/node_modules/zod/src/v3/tests/date.test.ts +32 -0
- package/node_modules/zod/src/v3/tests/deepmasking.test.ts +186 -0
- package/node_modules/zod/src/v3/tests/default.test.ts +112 -0
- package/node_modules/zod/src/v3/tests/description.test.ts +33 -0
- package/node_modules/zod/src/v3/tests/discriminated-unions.test.ts +315 -0
- package/node_modules/zod/src/v3/tests/enum.test.ts +80 -0
- package/node_modules/zod/src/v3/tests/error.test.ts +551 -0
- package/node_modules/zod/src/v3/tests/firstparty.test.ts +87 -0
- package/node_modules/zod/src/v3/tests/firstpartyschematypes.test.ts +21 -0
- package/node_modules/zod/src/v3/tests/function.test.ts +261 -0
- package/node_modules/zod/src/v3/tests/generics.test.ts +48 -0
- package/node_modules/zod/src/v3/tests/instanceof.test.ts +37 -0
- package/node_modules/zod/src/v3/tests/intersection.test.ts +110 -0
- package/node_modules/zod/src/v3/tests/language-server.source.ts +76 -0
- package/node_modules/zod/src/v3/tests/language-server.test.ts +207 -0
- package/node_modules/zod/src/v3/tests/literal.test.ts +36 -0
- package/node_modules/zod/src/v3/tests/map.test.ts +110 -0
- package/node_modules/zod/src/v3/tests/masking.test.ts +4 -0
- package/node_modules/zod/src/v3/tests/mocker.test.ts +19 -0
- package/node_modules/zod/src/v3/tests/nan.test.ts +24 -0
- package/node_modules/zod/src/v3/tests/nativeEnum.test.ts +87 -0
- package/node_modules/zod/src/v3/tests/nullable.test.ts +42 -0
- package/node_modules/zod/src/v3/tests/number.test.ts +176 -0
- package/node_modules/zod/src/v3/tests/object-augmentation.test.ts +29 -0
- package/node_modules/zod/src/v3/tests/object-in-es5-env.test.ts +29 -0
- package/node_modules/zod/src/v3/tests/object.test.ts +434 -0
- package/node_modules/zod/src/v3/tests/optional.test.ts +42 -0
- package/node_modules/zod/src/v3/tests/parseUtil.test.ts +23 -0
- package/node_modules/zod/src/v3/tests/parser.test.ts +41 -0
- package/node_modules/zod/src/v3/tests/partials.test.ts +243 -0
- package/node_modules/zod/src/v3/tests/pickomit.test.ts +111 -0
- package/node_modules/zod/src/v3/tests/pipeline.test.ts +29 -0
- package/node_modules/zod/src/v3/tests/preprocess.test.ts +186 -0
- package/node_modules/zod/src/v3/tests/primitive.test.ts +440 -0
- package/node_modules/zod/src/v3/tests/promise.test.ts +90 -0
- package/node_modules/zod/src/v3/tests/readonly.test.ts +194 -0
- package/node_modules/zod/src/v3/tests/record.test.ts +171 -0
- package/node_modules/zod/src/v3/tests/recursive.test.ts +197 -0
- package/node_modules/zod/src/v3/tests/refine.test.ts +313 -0
- package/node_modules/zod/src/v3/tests/safeparse.test.ts +27 -0
- package/node_modules/zod/src/v3/tests/set.test.ts +142 -0
- package/node_modules/zod/src/v3/tests/standard-schema.test.ts +83 -0
- package/node_modules/zod/src/v3/tests/string.test.ts +916 -0
- package/node_modules/zod/src/v3/tests/transformer.test.ts +233 -0
- package/node_modules/zod/src/v3/tests/tuple.test.ts +90 -0
- package/node_modules/zod/src/v3/tests/unions.test.ts +57 -0
- package/node_modules/zod/src/v3/tests/validations.test.ts +133 -0
- package/node_modules/zod/src/v3/tests/void.test.ts +15 -0
- package/node_modules/zod/src/v3/types.ts +5138 -0
- package/node_modules/zod/src/v4/classic/checks.ts +32 -0
- package/node_modules/zod/src/v4/classic/coerce.ts +27 -0
- package/node_modules/zod/src/v4/classic/compat.ts +70 -0
- package/node_modules/zod/src/v4/classic/errors.ts +82 -0
- package/node_modules/zod/src/v4/classic/external.ts +51 -0
- package/node_modules/zod/src/v4/classic/from-json-schema.ts +643 -0
- package/node_modules/zod/src/v4/classic/index.ts +5 -0
- package/node_modules/zod/src/v4/classic/iso.ts +90 -0
- package/node_modules/zod/src/v4/classic/parse.ts +82 -0
- package/node_modules/zod/src/v4/classic/schemas.ts +2409 -0
- package/node_modules/zod/src/v4/classic/tests/anyunknown.test.ts +26 -0
- package/node_modules/zod/src/v4/classic/tests/apply.test.ts +59 -0
- package/node_modules/zod/src/v4/classic/tests/array.test.ts +264 -0
- package/node_modules/zod/src/v4/classic/tests/assignability.test.ts +210 -0
- package/node_modules/zod/src/v4/classic/tests/async-parsing.test.ts +381 -0
- package/node_modules/zod/src/v4/classic/tests/async-refinements.test.ts +68 -0
- package/node_modules/zod/src/v4/classic/tests/base.test.ts +7 -0
- package/node_modules/zod/src/v4/classic/tests/bigint.test.ts +54 -0
- package/node_modules/zod/src/v4/classic/tests/brand.test.ts +106 -0
- package/node_modules/zod/src/v4/classic/tests/catch.test.ts +276 -0
- package/node_modules/zod/src/v4/classic/tests/coalesce.test.ts +20 -0
- package/node_modules/zod/src/v4/classic/tests/codec-examples.test.ts +573 -0
- package/node_modules/zod/src/v4/classic/tests/codec.test.ts +562 -0
- package/node_modules/zod/src/v4/classic/tests/coerce.test.ts +160 -0
- package/node_modules/zod/src/v4/classic/tests/continuability.test.ts +374 -0
- package/node_modules/zod/src/v4/classic/tests/custom.test.ts +40 -0
- package/node_modules/zod/src/v4/classic/tests/date.test.ts +62 -0
- package/node_modules/zod/src/v4/classic/tests/datetime.test.ts +302 -0
- package/node_modules/zod/src/v4/classic/tests/default.test.ts +365 -0
- package/node_modules/zod/src/v4/classic/tests/describe-meta-checks.test.ts +27 -0
- package/node_modules/zod/src/v4/classic/tests/description.test.ts +32 -0
- package/node_modules/zod/src/v4/classic/tests/discriminated-unions.test.ts +661 -0
- package/node_modules/zod/src/v4/classic/tests/enum.test.ts +285 -0
- package/node_modules/zod/src/v4/classic/tests/error-utils.test.ts +595 -0
- package/node_modules/zod/src/v4/classic/tests/error.test.ts +711 -0
- package/node_modules/zod/src/v4/classic/tests/file.test.ts +96 -0
- package/node_modules/zod/src/v4/classic/tests/firstparty.test.ts +179 -0
- package/node_modules/zod/src/v4/classic/tests/fix-json-issue.test.ts +26 -0
- package/node_modules/zod/src/v4/classic/tests/from-json-schema.test.ts +734 -0
- package/node_modules/zod/src/v4/classic/tests/function.test.ts +360 -0
- package/node_modules/zod/src/v4/classic/tests/generics.test.ts +72 -0
- package/node_modules/zod/src/v4/classic/tests/hash.test.ts +68 -0
- package/node_modules/zod/src/v4/classic/tests/index.test.ts +939 -0
- package/node_modules/zod/src/v4/classic/tests/instanceof.test.ts +60 -0
- package/node_modules/zod/src/v4/classic/tests/intersection.test.ts +198 -0
- package/node_modules/zod/src/v4/classic/tests/json.test.ts +109 -0
- package/node_modules/zod/src/v4/classic/tests/lazy.test.ts +227 -0
- package/node_modules/zod/src/v4/classic/tests/literal.test.ts +117 -0
- package/node_modules/zod/src/v4/classic/tests/map.test.ts +330 -0
- package/node_modules/zod/src/v4/classic/tests/nan.test.ts +21 -0
- package/node_modules/zod/src/v4/classic/tests/nested-refine.test.ts +168 -0
- package/node_modules/zod/src/v4/classic/tests/nonoptional.test.ts +101 -0
- package/node_modules/zod/src/v4/classic/tests/nullable.test.ts +22 -0
- package/node_modules/zod/src/v4/classic/tests/number.test.ts +270 -0
- package/node_modules/zod/src/v4/classic/tests/object.test.ts +640 -0
- package/node_modules/zod/src/v4/classic/tests/optional.test.ts +223 -0
- package/node_modules/zod/src/v4/classic/tests/partial.test.ts +427 -0
- package/node_modules/zod/src/v4/classic/tests/pickomit.test.ts +211 -0
- package/node_modules/zod/src/v4/classic/tests/pipe.test.ts +101 -0
- package/node_modules/zod/src/v4/classic/tests/prefault.test.ts +74 -0
- package/node_modules/zod/src/v4/classic/tests/preprocess.test.ts +282 -0
- package/node_modules/zod/src/v4/classic/tests/primitive.test.ts +175 -0
- package/node_modules/zod/src/v4/classic/tests/promise.test.ts +81 -0
- package/node_modules/zod/src/v4/classic/tests/prototypes.test.ts +23 -0
- package/node_modules/zod/src/v4/classic/tests/readonly.test.ts +252 -0
- package/node_modules/zod/src/v4/classic/tests/record.test.ts +632 -0
- package/node_modules/zod/src/v4/classic/tests/recursive-types.test.ts +582 -0
- package/node_modules/zod/src/v4/classic/tests/refine.test.ts +570 -0
- package/node_modules/zod/src/v4/classic/tests/registries.test.ts +243 -0
- package/node_modules/zod/src/v4/classic/tests/set.test.ts +181 -0
- package/node_modules/zod/src/v4/classic/tests/standard-schema.test.ts +134 -0
- package/node_modules/zod/src/v4/classic/tests/string-formats.test.ts +125 -0
- package/node_modules/zod/src/v4/classic/tests/string.test.ts +1175 -0
- package/node_modules/zod/src/v4/classic/tests/stringbool.test.ts +106 -0
- package/node_modules/zod/src/v4/classic/tests/template-literal.test.ts +771 -0
- package/node_modules/zod/src/v4/classic/tests/to-json-schema-methods.test.ts +438 -0
- package/node_modules/zod/src/v4/classic/tests/to-json-schema.test.ts +2990 -0
- package/node_modules/zod/src/v4/classic/tests/transform.test.ts +361 -0
- package/node_modules/zod/src/v4/classic/tests/tuple.test.ts +183 -0
- package/node_modules/zod/src/v4/classic/tests/union.test.ts +219 -0
- package/node_modules/zod/src/v4/classic/tests/url.test.ts +13 -0
- package/node_modules/zod/src/v4/classic/tests/validations.test.ts +283 -0
- package/node_modules/zod/src/v4/classic/tests/void.test.ts +12 -0
- package/node_modules/zod/src/v4/core/api.ts +1798 -0
- package/node_modules/zod/src/v4/core/checks.ts +1293 -0
- package/node_modules/zod/src/v4/core/config.ts +15 -0
- package/node_modules/zod/src/v4/core/core.ts +138 -0
- package/node_modules/zod/src/v4/core/doc.ts +44 -0
- package/node_modules/zod/src/v4/core/errors.ts +448 -0
- package/node_modules/zod/src/v4/core/index.ts +16 -0
- package/node_modules/zod/src/v4/core/json-schema-generator.ts +126 -0
- package/node_modules/zod/src/v4/core/json-schema-processors.ts +667 -0
- package/node_modules/zod/src/v4/core/json-schema.ts +147 -0
- package/node_modules/zod/src/v4/core/parse.ts +195 -0
- package/node_modules/zod/src/v4/core/regexes.ts +183 -0
- package/node_modules/zod/src/v4/core/registries.ts +105 -0
- package/node_modules/zod/src/v4/core/schemas.ts +4538 -0
- package/node_modules/zod/src/v4/core/standard-schema.ts +159 -0
- package/node_modules/zod/src/v4/core/tests/extend.test.ts +59 -0
- package/node_modules/zod/src/v4/core/tests/index.test.ts +46 -0
- package/node_modules/zod/src/v4/core/tests/locales/be.test.ts +124 -0
- package/node_modules/zod/src/v4/core/tests/locales/en.test.ts +22 -0
- package/node_modules/zod/src/v4/core/tests/locales/es.test.ts +181 -0
- package/node_modules/zod/src/v4/core/tests/locales/he.test.ts +379 -0
- package/node_modules/zod/src/v4/core/tests/locales/nl.test.ts +46 -0
- package/node_modules/zod/src/v4/core/tests/locales/ru.test.ts +128 -0
- package/node_modules/zod/src/v4/core/tests/locales/tr.test.ts +69 -0
- package/node_modules/zod/src/v4/core/tests/locales/uz.test.ts +83 -0
- package/node_modules/zod/src/v4/core/tests/record-constructor.test.ts +67 -0
- package/node_modules/zod/src/v4/core/tests/recursive-tuples.test.ts +45 -0
- package/node_modules/zod/src/v4/core/to-json-schema.ts +613 -0
- package/node_modules/zod/src/v4/core/util.ts +966 -0
- package/node_modules/zod/src/v4/core/versions.ts +5 -0
- package/node_modules/zod/src/v4/core/zsf.ts +323 -0
- package/node_modules/zod/src/v4/index.ts +4 -0
- package/node_modules/zod/src/v4/locales/ar.ts +115 -0
- package/node_modules/zod/src/v4/locales/az.ts +111 -0
- package/node_modules/zod/src/v4/locales/be.ts +176 -0
- package/node_modules/zod/src/v4/locales/bg.ts +128 -0
- package/node_modules/zod/src/v4/locales/ca.ts +116 -0
- package/node_modules/zod/src/v4/locales/cs.ts +118 -0
- package/node_modules/zod/src/v4/locales/da.ts +123 -0
- package/node_modules/zod/src/v4/locales/de.ts +116 -0
- package/node_modules/zod/src/v4/locales/en.ts +119 -0
- package/node_modules/zod/src/v4/locales/eo.ts +118 -0
- package/node_modules/zod/src/v4/locales/es.ts +141 -0
- package/node_modules/zod/src/v4/locales/fa.ts +126 -0
- package/node_modules/zod/src/v4/locales/fi.ts +121 -0
- package/node_modules/zod/src/v4/locales/fr-CA.ts +116 -0
- package/node_modules/zod/src/v4/locales/fr.ts +116 -0
- package/node_modules/zod/src/v4/locales/he.ts +246 -0
- package/node_modules/zod/src/v4/locales/hu.ts +117 -0
- package/node_modules/zod/src/v4/locales/hy.ts +164 -0
- package/node_modules/zod/src/v4/locales/id.ts +115 -0
- package/node_modules/zod/src/v4/locales/index.ts +49 -0
- package/node_modules/zod/src/v4/locales/is.ts +119 -0
- package/node_modules/zod/src/v4/locales/it.ts +116 -0
- package/node_modules/zod/src/v4/locales/ja.ts +114 -0
- package/node_modules/zod/src/v4/locales/ka.ts +123 -0
- package/node_modules/zod/src/v4/locales/kh.ts +7 -0
- package/node_modules/zod/src/v4/locales/km.ts +119 -0
- package/node_modules/zod/src/v4/locales/ko.ts +121 -0
- package/node_modules/zod/src/v4/locales/lt.ts +239 -0
- package/node_modules/zod/src/v4/locales/mk.ts +118 -0
- package/node_modules/zod/src/v4/locales/ms.ts +115 -0
- package/node_modules/zod/src/v4/locales/nl.ts +121 -0
- package/node_modules/zod/src/v4/locales/no.ts +116 -0
- package/node_modules/zod/src/v4/locales/ota.ts +117 -0
- package/node_modules/zod/src/v4/locales/pl.ts +118 -0
- package/node_modules/zod/src/v4/locales/ps.ts +126 -0
- package/node_modules/zod/src/v4/locales/pt.ts +116 -0
- package/node_modules/zod/src/v4/locales/ru.ts +176 -0
- package/node_modules/zod/src/v4/locales/sl.ts +118 -0
- package/node_modules/zod/src/v4/locales/sv.ts +119 -0
- package/node_modules/zod/src/v4/locales/ta.ts +118 -0
- package/node_modules/zod/src/v4/locales/th.ts +119 -0
- package/node_modules/zod/src/v4/locales/tr.ts +111 -0
- package/node_modules/zod/src/v4/locales/ua.ts +7 -0
- package/node_modules/zod/src/v4/locales/uk.ts +117 -0
- package/node_modules/zod/src/v4/locales/ur.ts +119 -0
- package/node_modules/zod/src/v4/locales/uz.ts +116 -0
- package/node_modules/zod/src/v4/locales/vi.ts +117 -0
- package/node_modules/zod/src/v4/locales/yo.ts +124 -0
- package/node_modules/zod/src/v4/locales/zh-CN.ts +116 -0
- package/node_modules/zod/src/v4/locales/zh-TW.ts +115 -0
- package/node_modules/zod/src/v4/mini/checks.ts +32 -0
- package/node_modules/zod/src/v4/mini/coerce.ts +27 -0
- package/node_modules/zod/src/v4/mini/external.ts +40 -0
- package/node_modules/zod/src/v4/mini/index.ts +3 -0
- package/node_modules/zod/src/v4/mini/iso.ts +66 -0
- package/node_modules/zod/src/v4/mini/parse.ts +14 -0
- package/node_modules/zod/src/v4/mini/schemas.ts +1916 -0
- package/node_modules/zod/src/v4/mini/tests/apply.test.ts +24 -0
- package/node_modules/zod/src/v4/mini/tests/assignability.test.ts +129 -0
- package/node_modules/zod/src/v4/mini/tests/brand.test.ts +94 -0
- package/node_modules/zod/src/v4/mini/tests/checks.test.ts +144 -0
- package/node_modules/zod/src/v4/mini/tests/codec.test.ts +529 -0
- package/node_modules/zod/src/v4/mini/tests/computed.test.ts +36 -0
- package/node_modules/zod/src/v4/mini/tests/error.test.ts +22 -0
- package/node_modules/zod/src/v4/mini/tests/functions.test.ts +5 -0
- package/node_modules/zod/src/v4/mini/tests/index.test.ts +963 -0
- package/node_modules/zod/src/v4/mini/tests/number.test.ts +95 -0
- package/node_modules/zod/src/v4/mini/tests/object.test.ts +227 -0
- package/node_modules/zod/src/v4/mini/tests/prototypes.test.ts +43 -0
- package/node_modules/zod/src/v4/mini/tests/recursive-types.test.ts +275 -0
- package/node_modules/zod/src/v4/mini/tests/standard-schema.test.ts +50 -0
- package/node_modules/zod/src/v4/mini/tests/string.test.ts +347 -0
- package/node_modules/zod/src/v4-mini/index.ts +3 -0
- package/node_modules/zod/v3/ZodError.cjs +138 -0
- package/node_modules/zod/v3/ZodError.d.cts +164 -0
- package/node_modules/zod/v3/ZodError.d.ts +164 -0
- package/node_modules/zod/v3/ZodError.js +133 -0
- package/node_modules/zod/v3/errors.cjs +17 -0
- package/node_modules/zod/v3/errors.d.cts +5 -0
- package/node_modules/zod/v3/errors.d.ts +5 -0
- package/node_modules/zod/v3/errors.js +9 -0
- package/node_modules/zod/v3/external.cjs +22 -0
- package/node_modules/zod/v3/external.d.cts +6 -0
- package/node_modules/zod/v3/external.d.ts +6 -0
- package/node_modules/zod/v3/external.js +6 -0
- package/node_modules/zod/v3/helpers/enumUtil.cjs +2 -0
- package/node_modules/zod/v3/helpers/enumUtil.d.cts +8 -0
- package/node_modules/zod/v3/helpers/enumUtil.d.ts +8 -0
- package/node_modules/zod/v3/helpers/enumUtil.js +1 -0
- package/node_modules/zod/v3/helpers/errorUtil.cjs +9 -0
- package/node_modules/zod/v3/helpers/errorUtil.d.cts +9 -0
- package/node_modules/zod/v3/helpers/errorUtil.d.ts +9 -0
- package/node_modules/zod/v3/helpers/errorUtil.js +6 -0
- package/node_modules/zod/v3/helpers/parseUtil.cjs +124 -0
- package/node_modules/zod/v3/helpers/parseUtil.d.cts +78 -0
- package/node_modules/zod/v3/helpers/parseUtil.d.ts +78 -0
- package/node_modules/zod/v3/helpers/parseUtil.js +109 -0
- package/node_modules/zod/v3/helpers/partialUtil.cjs +2 -0
- package/node_modules/zod/v3/helpers/partialUtil.d.cts +8 -0
- package/node_modules/zod/v3/helpers/partialUtil.d.ts +8 -0
- package/node_modules/zod/v3/helpers/partialUtil.js +1 -0
- package/node_modules/zod/v3/helpers/typeAliases.cjs +2 -0
- package/node_modules/zod/v3/helpers/typeAliases.d.cts +2 -0
- package/node_modules/zod/v3/helpers/typeAliases.d.ts +2 -0
- package/node_modules/zod/v3/helpers/typeAliases.js +1 -0
- package/node_modules/zod/v3/helpers/util.cjs +137 -0
- package/node_modules/zod/v3/helpers/util.d.cts +85 -0
- package/node_modules/zod/v3/helpers/util.d.ts +85 -0
- package/node_modules/zod/v3/helpers/util.js +133 -0
- package/node_modules/zod/v3/index.cjs +33 -0
- package/node_modules/zod/v3/index.d.cts +4 -0
- package/node_modules/zod/v3/index.d.ts +4 -0
- package/node_modules/zod/v3/index.js +4 -0
- package/node_modules/zod/v3/locales/en.cjs +112 -0
- package/node_modules/zod/v3/locales/en.d.cts +3 -0
- package/node_modules/zod/v3/locales/en.d.ts +3 -0
- package/node_modules/zod/v3/locales/en.js +109 -0
- package/node_modules/zod/v3/package.json +6 -0
- package/node_modules/zod/v3/standard-schema.cjs +2 -0
- package/node_modules/zod/v3/standard-schema.d.cts +102 -0
- package/node_modules/zod/v3/standard-schema.d.ts +102 -0
- package/node_modules/zod/v3/standard-schema.js +1 -0
- package/node_modules/zod/v3/types.cjs +3777 -0
- package/node_modules/zod/v3/types.d.cts +1034 -0
- package/node_modules/zod/v3/types.d.ts +1034 -0
- package/node_modules/zod/v3/types.js +3695 -0
- package/node_modules/zod/v4/classic/checks.cjs +33 -0
- package/node_modules/zod/v4/classic/checks.d.cts +1 -0
- package/node_modules/zod/v4/classic/checks.d.ts +1 -0
- package/node_modules/zod/v4/classic/checks.js +1 -0
- package/node_modules/zod/v4/classic/coerce.cjs +47 -0
- package/node_modules/zod/v4/classic/coerce.d.cts +17 -0
- package/node_modules/zod/v4/classic/coerce.d.ts +17 -0
- package/node_modules/zod/v4/classic/coerce.js +17 -0
- package/node_modules/zod/v4/classic/compat.cjs +61 -0
- package/node_modules/zod/v4/classic/compat.d.cts +50 -0
- package/node_modules/zod/v4/classic/compat.d.ts +50 -0
- package/node_modules/zod/v4/classic/compat.js +31 -0
- package/node_modules/zod/v4/classic/errors.cjs +74 -0
- package/node_modules/zod/v4/classic/errors.d.cts +30 -0
- package/node_modules/zod/v4/classic/errors.d.ts +30 -0
- package/node_modules/zod/v4/classic/errors.js +48 -0
- package/node_modules/zod/v4/classic/external.cjs +73 -0
- package/node_modules/zod/v4/classic/external.d.cts +15 -0
- package/node_modules/zod/v4/classic/external.d.ts +15 -0
- package/node_modules/zod/v4/classic/external.js +20 -0
- package/node_modules/zod/v4/classic/from-json-schema.cjs +610 -0
- package/node_modules/zod/v4/classic/from-json-schema.d.cts +12 -0
- package/node_modules/zod/v4/classic/from-json-schema.d.ts +12 -0
- package/node_modules/zod/v4/classic/from-json-schema.js +584 -0
- package/node_modules/zod/v4/classic/index.cjs +33 -0
- package/node_modules/zod/v4/classic/index.d.cts +4 -0
- package/node_modules/zod/v4/classic/index.d.ts +4 -0
- package/node_modules/zod/v4/classic/index.js +4 -0
- package/node_modules/zod/v4/classic/iso.cjs +60 -0
- package/node_modules/zod/v4/classic/iso.d.cts +22 -0
- package/node_modules/zod/v4/classic/iso.d.ts +22 -0
- package/node_modules/zod/v4/classic/iso.js +30 -0
- package/node_modules/zod/v4/classic/package.json +6 -0
- package/node_modules/zod/v4/classic/parse.cjs +41 -0
- package/node_modules/zod/v4/classic/parse.d.cts +31 -0
- package/node_modules/zod/v4/classic/parse.d.ts +31 -0
- package/node_modules/zod/v4/classic/parse.js +15 -0
- package/node_modules/zod/v4/classic/schemas.cjs +1272 -0
- package/node_modules/zod/v4/classic/schemas.d.cts +739 -0
- package/node_modules/zod/v4/classic/schemas.d.ts +739 -0
- package/node_modules/zod/v4/classic/schemas.js +1157 -0
- package/node_modules/zod/v4/core/api.cjs +1222 -0
- package/node_modules/zod/v4/core/api.d.cts +304 -0
- package/node_modules/zod/v4/core/api.d.ts +304 -0
- package/node_modules/zod/v4/core/api.js +1082 -0
- package/node_modules/zod/v4/core/checks.cjs +601 -0
- package/node_modules/zod/v4/core/checks.d.cts +278 -0
- package/node_modules/zod/v4/core/checks.d.ts +278 -0
- package/node_modules/zod/v4/core/checks.js +575 -0
- package/node_modules/zod/v4/core/core.cjs +83 -0
- package/node_modules/zod/v4/core/core.d.cts +70 -0
- package/node_modules/zod/v4/core/core.d.ts +70 -0
- package/node_modules/zod/v4/core/core.js +76 -0
- package/node_modules/zod/v4/core/doc.cjs +39 -0
- package/node_modules/zod/v4/core/doc.d.cts +14 -0
- package/node_modules/zod/v4/core/doc.d.ts +14 -0
- package/node_modules/zod/v4/core/doc.js +35 -0
- package/node_modules/zod/v4/core/errors.cjs +213 -0
- package/node_modules/zod/v4/core/errors.d.cts +220 -0
- package/node_modules/zod/v4/core/errors.d.ts +220 -0
- package/node_modules/zod/v4/core/errors.js +182 -0
- package/node_modules/zod/v4/core/index.cjs +47 -0
- package/node_modules/zod/v4/core/index.d.cts +16 -0
- package/node_modules/zod/v4/core/index.d.ts +16 -0
- package/node_modules/zod/v4/core/index.js +16 -0
- package/node_modules/zod/v4/core/json-schema-generator.cjs +99 -0
- package/node_modules/zod/v4/core/json-schema-generator.d.cts +65 -0
- package/node_modules/zod/v4/core/json-schema-generator.d.ts +65 -0
- package/node_modules/zod/v4/core/json-schema-generator.js +95 -0
- package/node_modules/zod/v4/core/json-schema-processors.cjs +648 -0
- package/node_modules/zod/v4/core/json-schema-processors.d.cts +49 -0
- package/node_modules/zod/v4/core/json-schema-processors.d.ts +49 -0
- package/node_modules/zod/v4/core/json-schema-processors.js +605 -0
- package/node_modules/zod/v4/core/json-schema.cjs +2 -0
- package/node_modules/zod/v4/core/json-schema.d.cts +88 -0
- package/node_modules/zod/v4/core/json-schema.d.ts +88 -0
- package/node_modules/zod/v4/core/json-schema.js +1 -0
- package/node_modules/zod/v4/core/package.json +6 -0
- package/node_modules/zod/v4/core/parse.cjs +131 -0
- package/node_modules/zod/v4/core/parse.d.cts +49 -0
- package/node_modules/zod/v4/core/parse.d.ts +49 -0
- package/node_modules/zod/v4/core/parse.js +93 -0
- package/node_modules/zod/v4/core/regexes.cjs +166 -0
- package/node_modules/zod/v4/core/regexes.d.cts +79 -0
- package/node_modules/zod/v4/core/regexes.d.ts +79 -0
- package/node_modules/zod/v4/core/regexes.js +133 -0
- package/node_modules/zod/v4/core/registries.cjs +56 -0
- package/node_modules/zod/v4/core/registries.d.cts +35 -0
- package/node_modules/zod/v4/core/registries.d.ts +35 -0
- package/node_modules/zod/v4/core/registries.js +51 -0
- package/node_modules/zod/v4/core/schemas.cjs +2124 -0
- package/node_modules/zod/v4/core/schemas.d.cts +1146 -0
- package/node_modules/zod/v4/core/schemas.d.ts +1146 -0
- package/node_modules/zod/v4/core/schemas.js +2093 -0
- package/node_modules/zod/v4/core/standard-schema.cjs +2 -0
- package/node_modules/zod/v4/core/standard-schema.d.cts +126 -0
- package/node_modules/zod/v4/core/standard-schema.d.ts +126 -0
- package/node_modules/zod/v4/core/standard-schema.js +1 -0
- package/node_modules/zod/v4/core/to-json-schema.cjs +446 -0
- package/node_modules/zod/v4/core/to-json-schema.d.cts +114 -0
- package/node_modules/zod/v4/core/to-json-schema.d.ts +114 -0
- package/node_modules/zod/v4/core/to-json-schema.js +437 -0
- package/node_modules/zod/v4/core/util.cjs +710 -0
- package/node_modules/zod/v4/core/util.d.cts +199 -0
- package/node_modules/zod/v4/core/util.d.ts +199 -0
- package/node_modules/zod/v4/core/util.js +651 -0
- package/node_modules/zod/v4/core/versions.cjs +8 -0
- package/node_modules/zod/v4/core/versions.d.cts +5 -0
- package/node_modules/zod/v4/core/versions.d.ts +5 -0
- package/node_modules/zod/v4/core/versions.js +5 -0
- package/node_modules/zod/v4/index.cjs +22 -0
- package/node_modules/zod/v4/index.d.cts +3 -0
- package/node_modules/zod/v4/index.d.ts +3 -0
- package/node_modules/zod/v4/index.js +3 -0
- package/node_modules/zod/v4/locales/ar.cjs +133 -0
- package/node_modules/zod/v4/locales/ar.d.cts +5 -0
- package/node_modules/zod/v4/locales/ar.d.ts +4 -0
- package/node_modules/zod/v4/locales/ar.js +106 -0
- package/node_modules/zod/v4/locales/az.cjs +132 -0
- package/node_modules/zod/v4/locales/az.d.cts +5 -0
- package/node_modules/zod/v4/locales/az.d.ts +4 -0
- package/node_modules/zod/v4/locales/az.js +105 -0
- package/node_modules/zod/v4/locales/be.cjs +183 -0
- package/node_modules/zod/v4/locales/be.d.cts +5 -0
- package/node_modules/zod/v4/locales/be.d.ts +4 -0
- package/node_modules/zod/v4/locales/be.js +156 -0
- package/node_modules/zod/v4/locales/bg.cjs +147 -0
- package/node_modules/zod/v4/locales/bg.d.cts +5 -0
- package/node_modules/zod/v4/locales/bg.d.ts +4 -0
- package/node_modules/zod/v4/locales/bg.js +120 -0
- package/node_modules/zod/v4/locales/ca.cjs +134 -0
- package/node_modules/zod/v4/locales/ca.d.cts +5 -0
- package/node_modules/zod/v4/locales/ca.d.ts +4 -0
- package/node_modules/zod/v4/locales/ca.js +107 -0
- package/node_modules/zod/v4/locales/cs.cjs +138 -0
- package/node_modules/zod/v4/locales/cs.d.cts +5 -0
- package/node_modules/zod/v4/locales/cs.d.ts +4 -0
- package/node_modules/zod/v4/locales/cs.js +111 -0
- package/node_modules/zod/v4/locales/da.cjs +142 -0
- package/node_modules/zod/v4/locales/da.d.cts +5 -0
- package/node_modules/zod/v4/locales/da.d.ts +4 -0
- package/node_modules/zod/v4/locales/da.js +115 -0
- package/node_modules/zod/v4/locales/de.cjs +135 -0
- package/node_modules/zod/v4/locales/de.d.cts +5 -0
- package/node_modules/zod/v4/locales/de.d.ts +4 -0
- package/node_modules/zod/v4/locales/de.js +108 -0
- package/node_modules/zod/v4/locales/en.cjs +136 -0
- package/node_modules/zod/v4/locales/en.d.cts +5 -0
- package/node_modules/zod/v4/locales/en.d.ts +4 -0
- package/node_modules/zod/v4/locales/en.js +109 -0
- package/node_modules/zod/v4/locales/eo.cjs +136 -0
- package/node_modules/zod/v4/locales/eo.d.cts +5 -0
- package/node_modules/zod/v4/locales/eo.d.ts +4 -0
- package/node_modules/zod/v4/locales/eo.js +109 -0
- package/node_modules/zod/v4/locales/es.cjs +159 -0
- package/node_modules/zod/v4/locales/es.d.cts +5 -0
- package/node_modules/zod/v4/locales/es.d.ts +4 -0
- package/node_modules/zod/v4/locales/es.js +132 -0
- package/node_modules/zod/v4/locales/fa.cjs +141 -0
- package/node_modules/zod/v4/locales/fa.d.cts +5 -0
- package/node_modules/zod/v4/locales/fa.d.ts +4 -0
- package/node_modules/zod/v4/locales/fa.js +114 -0
- package/node_modules/zod/v4/locales/fi.cjs +139 -0
- package/node_modules/zod/v4/locales/fi.d.cts +5 -0
- package/node_modules/zod/v4/locales/fi.d.ts +4 -0
- package/node_modules/zod/v4/locales/fi.js +112 -0
- package/node_modules/zod/v4/locales/fr-CA.cjs +134 -0
- package/node_modules/zod/v4/locales/fr-CA.d.cts +5 -0
- package/node_modules/zod/v4/locales/fr-CA.d.ts +4 -0
- package/node_modules/zod/v4/locales/fr-CA.js +107 -0
- package/node_modules/zod/v4/locales/fr.cjs +135 -0
- package/node_modules/zod/v4/locales/fr.d.cts +5 -0
- package/node_modules/zod/v4/locales/fr.d.ts +4 -0
- package/node_modules/zod/v4/locales/fr.js +108 -0
- package/node_modules/zod/v4/locales/he.cjs +241 -0
- package/node_modules/zod/v4/locales/he.d.cts +5 -0
- package/node_modules/zod/v4/locales/he.d.ts +4 -0
- package/node_modules/zod/v4/locales/he.js +214 -0
- package/node_modules/zod/v4/locales/hu.cjs +135 -0
- package/node_modules/zod/v4/locales/hu.d.cts +5 -0
- package/node_modules/zod/v4/locales/hu.d.ts +4 -0
- package/node_modules/zod/v4/locales/hu.js +108 -0
- package/node_modules/zod/v4/locales/hy.cjs +174 -0
- package/node_modules/zod/v4/locales/hy.d.cts +5 -0
- package/node_modules/zod/v4/locales/hy.d.ts +4 -0
- package/node_modules/zod/v4/locales/hy.js +147 -0
- package/node_modules/zod/v4/locales/id.cjs +133 -0
- package/node_modules/zod/v4/locales/id.d.cts +5 -0
- package/node_modules/zod/v4/locales/id.d.ts +4 -0
- package/node_modules/zod/v4/locales/id.js +106 -0
- package/node_modules/zod/v4/locales/index.cjs +104 -0
- package/node_modules/zod/v4/locales/index.d.cts +49 -0
- package/node_modules/zod/v4/locales/index.d.ts +49 -0
- package/node_modules/zod/v4/locales/index.js +49 -0
- package/node_modules/zod/v4/locales/is.cjs +136 -0
- package/node_modules/zod/v4/locales/is.d.cts +5 -0
- package/node_modules/zod/v4/locales/is.d.ts +4 -0
- package/node_modules/zod/v4/locales/is.js +109 -0
- package/node_modules/zod/v4/locales/it.cjs +135 -0
- package/node_modules/zod/v4/locales/it.d.cts +5 -0
- package/node_modules/zod/v4/locales/it.d.ts +4 -0
- package/node_modules/zod/v4/locales/it.js +108 -0
- package/node_modules/zod/v4/locales/ja.cjs +134 -0
- package/node_modules/zod/v4/locales/ja.d.cts +5 -0
- package/node_modules/zod/v4/locales/ja.d.ts +4 -0
- package/node_modules/zod/v4/locales/ja.js +107 -0
- package/node_modules/zod/v4/locales/ka.cjs +139 -0
- package/node_modules/zod/v4/locales/ka.d.cts +5 -0
- package/node_modules/zod/v4/locales/ka.d.ts +4 -0
- package/node_modules/zod/v4/locales/ka.js +112 -0
- package/node_modules/zod/v4/locales/kh.cjs +12 -0
- package/node_modules/zod/v4/locales/kh.d.cts +5 -0
- package/node_modules/zod/v4/locales/kh.d.ts +5 -0
- package/node_modules/zod/v4/locales/kh.js +5 -0
- package/node_modules/zod/v4/locales/km.cjs +137 -0
- package/node_modules/zod/v4/locales/km.d.cts +5 -0
- package/node_modules/zod/v4/locales/km.d.ts +4 -0
- package/node_modules/zod/v4/locales/km.js +110 -0
- package/node_modules/zod/v4/locales/ko.cjs +138 -0
- package/node_modules/zod/v4/locales/ko.d.cts +5 -0
- package/node_modules/zod/v4/locales/ko.d.ts +4 -0
- package/node_modules/zod/v4/locales/ko.js +111 -0
- package/node_modules/zod/v4/locales/lt.cjs +230 -0
- package/node_modules/zod/v4/locales/lt.d.cts +5 -0
- package/node_modules/zod/v4/locales/lt.d.ts +4 -0
- package/node_modules/zod/v4/locales/lt.js +203 -0
- package/node_modules/zod/v4/locales/mk.cjs +136 -0
- package/node_modules/zod/v4/locales/mk.d.cts +5 -0
- package/node_modules/zod/v4/locales/mk.d.ts +4 -0
- package/node_modules/zod/v4/locales/mk.js +109 -0
- package/node_modules/zod/v4/locales/ms.cjs +134 -0
- package/node_modules/zod/v4/locales/ms.d.cts +5 -0
- package/node_modules/zod/v4/locales/ms.d.ts +4 -0
- package/node_modules/zod/v4/locales/ms.js +107 -0
- package/node_modules/zod/v4/locales/nl.cjs +137 -0
- package/node_modules/zod/v4/locales/nl.d.cts +5 -0
- package/node_modules/zod/v4/locales/nl.d.ts +4 -0
- package/node_modules/zod/v4/locales/nl.js +110 -0
- package/node_modules/zod/v4/locales/no.cjs +135 -0
- package/node_modules/zod/v4/locales/no.d.cts +5 -0
- package/node_modules/zod/v4/locales/no.d.ts +4 -0
- package/node_modules/zod/v4/locales/no.js +108 -0
- package/node_modules/zod/v4/locales/ota.cjs +136 -0
- package/node_modules/zod/v4/locales/ota.d.cts +5 -0
- package/node_modules/zod/v4/locales/ota.d.ts +4 -0
- package/node_modules/zod/v4/locales/ota.js +109 -0
- package/node_modules/zod/v4/locales/package.json +6 -0
- package/node_modules/zod/v4/locales/pl.cjs +136 -0
- package/node_modules/zod/v4/locales/pl.d.cts +5 -0
- package/node_modules/zod/v4/locales/pl.d.ts +4 -0
- package/node_modules/zod/v4/locales/pl.js +109 -0
- package/node_modules/zod/v4/locales/ps.cjs +141 -0
- package/node_modules/zod/v4/locales/ps.d.cts +5 -0
- package/node_modules/zod/v4/locales/ps.d.ts +4 -0
- package/node_modules/zod/v4/locales/ps.js +114 -0
- package/node_modules/zod/v4/locales/pt.cjs +135 -0
- package/node_modules/zod/v4/locales/pt.d.cts +5 -0
- package/node_modules/zod/v4/locales/pt.d.ts +4 -0
- package/node_modules/zod/v4/locales/pt.js +108 -0
- package/node_modules/zod/v4/locales/ru.cjs +183 -0
- package/node_modules/zod/v4/locales/ru.d.cts +5 -0
- package/node_modules/zod/v4/locales/ru.d.ts +4 -0
- package/node_modules/zod/v4/locales/ru.js +156 -0
- package/node_modules/zod/v4/locales/sl.cjs +136 -0
- package/node_modules/zod/v4/locales/sl.d.cts +5 -0
- package/node_modules/zod/v4/locales/sl.d.ts +4 -0
- package/node_modules/zod/v4/locales/sl.js +109 -0
- package/node_modules/zod/v4/locales/sv.cjs +137 -0
- package/node_modules/zod/v4/locales/sv.d.cts +5 -0
- package/node_modules/zod/v4/locales/sv.d.ts +4 -0
- package/node_modules/zod/v4/locales/sv.js +110 -0
- package/node_modules/zod/v4/locales/ta.cjs +137 -0
- package/node_modules/zod/v4/locales/ta.d.cts +5 -0
- package/node_modules/zod/v4/locales/ta.d.ts +4 -0
- package/node_modules/zod/v4/locales/ta.js +110 -0
- package/node_modules/zod/v4/locales/th.cjs +137 -0
- package/node_modules/zod/v4/locales/th.d.cts +5 -0
- package/node_modules/zod/v4/locales/th.d.ts +4 -0
- package/node_modules/zod/v4/locales/th.js +110 -0
- package/node_modules/zod/v4/locales/tr.cjs +132 -0
- package/node_modules/zod/v4/locales/tr.d.cts +5 -0
- package/node_modules/zod/v4/locales/tr.d.ts +4 -0
- package/node_modules/zod/v4/locales/tr.js +105 -0
- package/node_modules/zod/v4/locales/ua.cjs +12 -0
- package/node_modules/zod/v4/locales/ua.d.cts +5 -0
- package/node_modules/zod/v4/locales/ua.d.ts +5 -0
- package/node_modules/zod/v4/locales/ua.js +5 -0
- package/node_modules/zod/v4/locales/uk.cjs +135 -0
- package/node_modules/zod/v4/locales/uk.d.cts +5 -0
- package/node_modules/zod/v4/locales/uk.d.ts +4 -0
- package/node_modules/zod/v4/locales/uk.js +108 -0
- package/node_modules/zod/v4/locales/ur.cjs +137 -0
- package/node_modules/zod/v4/locales/ur.d.cts +5 -0
- package/node_modules/zod/v4/locales/ur.d.ts +4 -0
- package/node_modules/zod/v4/locales/ur.js +110 -0
- package/node_modules/zod/v4/locales/uz.cjs +136 -0
- package/node_modules/zod/v4/locales/uz.d.cts +5 -0
- package/node_modules/zod/v4/locales/uz.d.ts +4 -0
- package/node_modules/zod/v4/locales/uz.js +109 -0
- package/node_modules/zod/v4/locales/vi.cjs +135 -0
- package/node_modules/zod/v4/locales/vi.d.cts +5 -0
- package/node_modules/zod/v4/locales/vi.d.ts +4 -0
- package/node_modules/zod/v4/locales/vi.js +108 -0
- package/node_modules/zod/v4/locales/yo.cjs +134 -0
- package/node_modules/zod/v4/locales/yo.d.cts +5 -0
- package/node_modules/zod/v4/locales/yo.d.ts +4 -0
- package/node_modules/zod/v4/locales/yo.js +107 -0
- package/node_modules/zod/v4/locales/zh-CN.cjs +136 -0
- package/node_modules/zod/v4/locales/zh-CN.d.cts +5 -0
- package/node_modules/zod/v4/locales/zh-CN.d.ts +4 -0
- package/node_modules/zod/v4/locales/zh-CN.js +109 -0
- package/node_modules/zod/v4/locales/zh-TW.cjs +134 -0
- package/node_modules/zod/v4/locales/zh-TW.d.cts +5 -0
- package/node_modules/zod/v4/locales/zh-TW.d.ts +4 -0
- package/node_modules/zod/v4/locales/zh-TW.js +107 -0
- package/node_modules/zod/v4/mini/checks.cjs +34 -0
- package/node_modules/zod/v4/mini/checks.d.cts +1 -0
- package/node_modules/zod/v4/mini/checks.d.ts +1 -0
- package/node_modules/zod/v4/mini/checks.js +1 -0
- package/node_modules/zod/v4/mini/coerce.cjs +52 -0
- package/node_modules/zod/v4/mini/coerce.d.cts +7 -0
- package/node_modules/zod/v4/mini/coerce.d.ts +7 -0
- package/node_modules/zod/v4/mini/coerce.js +22 -0
- package/node_modules/zod/v4/mini/external.cjs +63 -0
- package/node_modules/zod/v4/mini/external.d.cts +12 -0
- package/node_modules/zod/v4/mini/external.d.ts +12 -0
- package/node_modules/zod/v4/mini/external.js +14 -0
- package/node_modules/zod/v4/mini/index.cjs +32 -0
- package/node_modules/zod/v4/mini/index.d.cts +3 -0
- package/node_modules/zod/v4/mini/index.d.ts +3 -0
- package/node_modules/zod/v4/mini/index.js +3 -0
- package/node_modules/zod/v4/mini/iso.cjs +64 -0
- package/node_modules/zod/v4/mini/iso.d.cts +22 -0
- package/node_modules/zod/v4/mini/iso.d.ts +22 -0
- package/node_modules/zod/v4/mini/iso.js +34 -0
- package/node_modules/zod/v4/mini/package.json +6 -0
- package/node_modules/zod/v4/mini/parse.cjs +16 -0
- package/node_modules/zod/v4/mini/parse.d.cts +1 -0
- package/node_modules/zod/v4/mini/parse.d.ts +1 -0
- package/node_modules/zod/v4/mini/parse.js +1 -0
- package/node_modules/zod/v4/mini/schemas.cjs +1046 -0
- package/node_modules/zod/v4/mini/schemas.d.cts +427 -0
- package/node_modules/zod/v4/mini/schemas.d.ts +427 -0
- package/node_modules/zod/v4/mini/schemas.js +925 -0
- package/node_modules/zod/v4/package.json +6 -0
- package/node_modules/zod/v4-mini/index.cjs +32 -0
- package/node_modules/zod/v4-mini/index.d.cts +3 -0
- package/node_modules/zod/v4-mini/index.d.ts +3 -0
- package/node_modules/zod/v4-mini/index.js +3 -0
- package/node_modules/zod/v4-mini/package.json +6 -0
- package/package.json +140 -0
- package/pnpm-workspace.yaml +15 -0
- package/scripts/generate-pnpm-workspace-types.ts +33 -0
package/API.md
ADDED
|
@@ -0,0 +1,1812 @@
|
|
|
1
|
+
# API Reference <a name="API Reference" id="api-reference"></a>
|
|
2
|
+
|
|
3
|
+
## Constructs <a name="Constructs" id="Constructs"></a>
|
|
4
|
+
|
|
5
|
+
### AlmaCdkConstructLibrary <a name="AlmaCdkConstructLibrary" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary"></a>
|
|
6
|
+
|
|
7
|
+
#### Initializers <a name="Initializers" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.Initializer"></a>
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
import { AlmaCdkConstructLibrary } from '@alma-cdk/construct-library'
|
|
11
|
+
|
|
12
|
+
new AlmaCdkConstructLibrary(options: AlmaCdkConstructLibraryOptions)
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
| **Name** | **Type** | **Description** |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.Initializer.parameter.options">options</a></code> | <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions">AlmaCdkConstructLibraryOptions</a></code> | *No description.* |
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
##### `options`<sup>Required</sup> <a name="options" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.Initializer.parameter.options"></a>
|
|
22
|
+
|
|
23
|
+
- *Type:* <a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions">AlmaCdkConstructLibraryOptions</a>
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
28
|
+
|
|
29
|
+
| **Name** | **Description** |
|
|
30
|
+
| --- | --- |
|
|
31
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
32
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.with">with</a></code> | Applies one or more mixins to this construct. |
|
|
33
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
|
|
34
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
|
|
35
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
|
|
36
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.addTask">addTask</a></code> | Adds a new task to this project. |
|
|
37
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
|
|
38
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
|
|
39
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.postSynthesize">postSynthesize</a></code> | Called after all components are synthesized. |
|
|
40
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.preSynthesize">preSynthesize</a></code> | Called before all components are synthesized. |
|
|
41
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.removeTask">removeTask</a></code> | Removes a task from a project. |
|
|
42
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.runTaskCommand">runTaskCommand</a></code> | Returns the shell command to execute in order to run a task. |
|
|
43
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.synth">synth</a></code> | Synthesize all project files into `outdir`. |
|
|
44
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.tryFindFile">tryFindFile</a></code> | Finds a file at the specified relative path within this project and all its subprojects. |
|
|
45
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.tryFindJsonFile">tryFindJsonFile</a></code> | Finds a json file by name. |
|
|
46
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.tryFindObjectFile">tryFindObjectFile</a></code> | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
|
|
47
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.tryRemoveFile">tryRemoveFile</a></code> | Finds a file at the specified relative path within this project and removes it. |
|
|
48
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.addBins">addBins</a></code> | *No description.* |
|
|
49
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.addBundledDeps">addBundledDeps</a></code> | Defines bundled dependencies. |
|
|
50
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.addCompileCommand">addCompileCommand</a></code> | DEPRECATED. |
|
|
51
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.addDeps">addDeps</a></code> | Defines normal dependencies. |
|
|
52
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.addDevDeps">addDevDeps</a></code> | Defines development/test dependencies. |
|
|
53
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.addFields">addFields</a></code> | Directly set fields in `package.json`. |
|
|
54
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
|
|
55
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
|
|
56
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.addScripts">addScripts</a></code> | Replaces the contents of multiple npm package.json scripts. |
|
|
57
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
|
|
58
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
|
|
59
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
|
|
60
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.renderWorkflowSetup">renderWorkflowSetup</a></code> | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
|
|
61
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
|
|
62
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.addCdkDependencies">addCdkDependencies</a></code> | Adds dependencies to AWS CDK modules. |
|
|
63
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.addCdkTestDependencies">addCdkTestDependencies</a></code> | Adds AWS CDK modules as dev dependencies. |
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
##### `toString` <a name="toString" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.toString"></a>
|
|
68
|
+
|
|
69
|
+
```typescript
|
|
70
|
+
public toString(): string
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Returns a string representation of this construct.
|
|
74
|
+
|
|
75
|
+
##### `with` <a name="with" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.with"></a>
|
|
76
|
+
|
|
77
|
+
```typescript
|
|
78
|
+
public with(mixins: ...IMixin[]): IConstruct
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Applies one or more mixins to this construct.
|
|
82
|
+
|
|
83
|
+
Mixins are applied in order. The list of constructs is captured at the
|
|
84
|
+
start of the call, so constructs added by a mixin will not be visited.
|
|
85
|
+
Use multiple `with()` calls if subsequent mixins should apply to added
|
|
86
|
+
constructs.
|
|
87
|
+
|
|
88
|
+
###### `mixins`<sup>Required</sup> <a name="mixins" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.with.parameter.mixins"></a>
|
|
89
|
+
|
|
90
|
+
- *Type:* ...constructs.IMixin[]
|
|
91
|
+
|
|
92
|
+
The mixins to apply.
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
|
|
96
|
+
##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addExcludeFromCleanup"></a>
|
|
97
|
+
|
|
98
|
+
```typescript
|
|
99
|
+
public addExcludeFromCleanup(globs: ...string[]): void
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Exclude the matching files from pre-synth cleanup.
|
|
103
|
+
|
|
104
|
+
Can be used when, for example, some
|
|
105
|
+
source files include the projen marker and we don't want them to be erased during synth.
|
|
106
|
+
|
|
107
|
+
###### `globs`<sup>Required</sup> <a name="globs" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addExcludeFromCleanup.parameter.globs"></a>
|
|
108
|
+
|
|
109
|
+
- *Type:* ...string[]
|
|
110
|
+
|
|
111
|
+
The glob patterns to match.
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
##### `addGitIgnore` <a name="addGitIgnore" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addGitIgnore"></a>
|
|
116
|
+
|
|
117
|
+
```typescript
|
|
118
|
+
public addGitIgnore(pattern: string): void
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
Adds a .gitignore pattern.
|
|
122
|
+
|
|
123
|
+
###### `pattern`<sup>Required</sup> <a name="pattern" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addGitIgnore.parameter.pattern"></a>
|
|
124
|
+
|
|
125
|
+
- *Type:* string
|
|
126
|
+
|
|
127
|
+
The glob pattern to ignore.
|
|
128
|
+
|
|
129
|
+
---
|
|
130
|
+
|
|
131
|
+
##### `addPackageIgnore` <a name="addPackageIgnore" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addPackageIgnore"></a>
|
|
132
|
+
|
|
133
|
+
```typescript
|
|
134
|
+
public addPackageIgnore(pattern: string): void
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
Adds patterns to be ignored by npm.
|
|
138
|
+
|
|
139
|
+
###### `pattern`<sup>Required</sup> <a name="pattern" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addPackageIgnore.parameter.pattern"></a>
|
|
140
|
+
|
|
141
|
+
- *Type:* string
|
|
142
|
+
|
|
143
|
+
The pattern to ignore.
|
|
144
|
+
|
|
145
|
+
---
|
|
146
|
+
|
|
147
|
+
##### `addTask` <a name="addTask" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addTask"></a>
|
|
148
|
+
|
|
149
|
+
```typescript
|
|
150
|
+
public addTask(name: string, props?: TaskOptions): Task
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
Adds a new task to this project.
|
|
154
|
+
|
|
155
|
+
This will fail if the project already has
|
|
156
|
+
a task with this name.
|
|
157
|
+
|
|
158
|
+
###### `name`<sup>Required</sup> <a name="name" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addTask.parameter.name"></a>
|
|
159
|
+
|
|
160
|
+
- *Type:* string
|
|
161
|
+
|
|
162
|
+
The task name to add.
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
###### `props`<sup>Optional</sup> <a name="props" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addTask.parameter.props"></a>
|
|
167
|
+
|
|
168
|
+
- *Type:* projen.TaskOptions
|
|
169
|
+
|
|
170
|
+
Task properties.
|
|
171
|
+
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
##### ~~`addTip`~~ <a name="addTip" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addTip"></a>
|
|
175
|
+
|
|
176
|
+
```typescript
|
|
177
|
+
public addTip(message: string): void
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
Prints a "tip" message during synthesis.
|
|
181
|
+
|
|
182
|
+
###### `message`<sup>Required</sup> <a name="message" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addTip.parameter.message"></a>
|
|
183
|
+
|
|
184
|
+
- *Type:* string
|
|
185
|
+
|
|
186
|
+
The message.
|
|
187
|
+
|
|
188
|
+
---
|
|
189
|
+
|
|
190
|
+
##### `annotateGenerated` <a name="annotateGenerated" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.annotateGenerated"></a>
|
|
191
|
+
|
|
192
|
+
```typescript
|
|
193
|
+
public annotateGenerated(glob: string): void
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
Marks the provided file(s) as being generated.
|
|
197
|
+
|
|
198
|
+
This is achieved using the
|
|
199
|
+
github-linguist attributes. Generated files do not count against the
|
|
200
|
+
repository statistics and language breakdown.
|
|
201
|
+
|
|
202
|
+
> [https://github.com/github/linguist/blob/master/docs/overrides.md](https://github.com/github/linguist/blob/master/docs/overrides.md)
|
|
203
|
+
|
|
204
|
+
###### `glob`<sup>Required</sup> <a name="glob" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.annotateGenerated.parameter.glob"></a>
|
|
205
|
+
|
|
206
|
+
- *Type:* string
|
|
207
|
+
|
|
208
|
+
the glob pattern to match (could be a file path).
|
|
209
|
+
|
|
210
|
+
---
|
|
211
|
+
|
|
212
|
+
##### `postSynthesize` <a name="postSynthesize" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.postSynthesize"></a>
|
|
213
|
+
|
|
214
|
+
```typescript
|
|
215
|
+
public postSynthesize(): void
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
Called after all components are synthesized.
|
|
219
|
+
|
|
220
|
+
Order is *not* guaranteed.
|
|
221
|
+
|
|
222
|
+
##### `preSynthesize` <a name="preSynthesize" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.preSynthesize"></a>
|
|
223
|
+
|
|
224
|
+
```typescript
|
|
225
|
+
public preSynthesize(): void
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
Called before all components are synthesized.
|
|
229
|
+
|
|
230
|
+
##### `removeTask` <a name="removeTask" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.removeTask"></a>
|
|
231
|
+
|
|
232
|
+
```typescript
|
|
233
|
+
public removeTask(name: string): Task
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
Removes a task from a project.
|
|
237
|
+
|
|
238
|
+
###### `name`<sup>Required</sup> <a name="name" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.removeTask.parameter.name"></a>
|
|
239
|
+
|
|
240
|
+
- *Type:* string
|
|
241
|
+
|
|
242
|
+
The name of the task to remove.
|
|
243
|
+
|
|
244
|
+
---
|
|
245
|
+
|
|
246
|
+
##### `runTaskCommand` <a name="runTaskCommand" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.runTaskCommand"></a>
|
|
247
|
+
|
|
248
|
+
```typescript
|
|
249
|
+
public runTaskCommand(task: Task): string
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
Returns the shell command to execute in order to run a task.
|
|
253
|
+
|
|
254
|
+
This will
|
|
255
|
+
typically be `npx projen TASK`.
|
|
256
|
+
|
|
257
|
+
###### `task`<sup>Required</sup> <a name="task" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.runTaskCommand.parameter.task"></a>
|
|
258
|
+
|
|
259
|
+
- *Type:* projen.Task
|
|
260
|
+
|
|
261
|
+
The task for which the command is required.
|
|
262
|
+
|
|
263
|
+
---
|
|
264
|
+
|
|
265
|
+
##### `synth` <a name="synth" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.synth"></a>
|
|
266
|
+
|
|
267
|
+
```typescript
|
|
268
|
+
public synth(): void
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
Synthesize all project files into `outdir`.
|
|
272
|
+
|
|
273
|
+
1. Call "this.preSynthesize()"
|
|
274
|
+
2. Delete all generated files
|
|
275
|
+
3. Synthesize all subprojects
|
|
276
|
+
4. Synthesize all components of this project
|
|
277
|
+
5. Call "postSynthesize()" for all components of this project
|
|
278
|
+
6. Call "this.postSynthesize()"
|
|
279
|
+
|
|
280
|
+
##### `tryFindFile` <a name="tryFindFile" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.tryFindFile"></a>
|
|
281
|
+
|
|
282
|
+
```typescript
|
|
283
|
+
public tryFindFile(filePath: string): FileBase
|
|
284
|
+
```
|
|
285
|
+
|
|
286
|
+
Finds a file at the specified relative path within this project and all its subprojects.
|
|
287
|
+
|
|
288
|
+
###### `filePath`<sup>Required</sup> <a name="filePath" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.tryFindFile.parameter.filePath"></a>
|
|
289
|
+
|
|
290
|
+
- *Type:* string
|
|
291
|
+
|
|
292
|
+
The file path.
|
|
293
|
+
|
|
294
|
+
If this path is relative, it will be resolved
|
|
295
|
+
from the root of _this_ project.
|
|
296
|
+
|
|
297
|
+
---
|
|
298
|
+
|
|
299
|
+
##### ~~`tryFindJsonFile`~~ <a name="tryFindJsonFile" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.tryFindJsonFile"></a>
|
|
300
|
+
|
|
301
|
+
```typescript
|
|
302
|
+
public tryFindJsonFile(filePath: string): JsonFile
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
Finds a json file by name.
|
|
306
|
+
|
|
307
|
+
###### `filePath`<sup>Required</sup> <a name="filePath" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.tryFindJsonFile.parameter.filePath"></a>
|
|
308
|
+
|
|
309
|
+
- *Type:* string
|
|
310
|
+
|
|
311
|
+
The file path.
|
|
312
|
+
|
|
313
|
+
---
|
|
314
|
+
|
|
315
|
+
##### `tryFindObjectFile` <a name="tryFindObjectFile" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.tryFindObjectFile"></a>
|
|
316
|
+
|
|
317
|
+
```typescript
|
|
318
|
+
public tryFindObjectFile(filePath: string): ObjectFile
|
|
319
|
+
```
|
|
320
|
+
|
|
321
|
+
Finds an object file (like JsonFile, YamlFile, etc.) by name.
|
|
322
|
+
|
|
323
|
+
###### `filePath`<sup>Required</sup> <a name="filePath" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.tryFindObjectFile.parameter.filePath"></a>
|
|
324
|
+
|
|
325
|
+
- *Type:* string
|
|
326
|
+
|
|
327
|
+
The file path.
|
|
328
|
+
|
|
329
|
+
---
|
|
330
|
+
|
|
331
|
+
##### `tryRemoveFile` <a name="tryRemoveFile" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.tryRemoveFile"></a>
|
|
332
|
+
|
|
333
|
+
```typescript
|
|
334
|
+
public tryRemoveFile(filePath: string): FileBase
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
Finds a file at the specified relative path within this project and removes it.
|
|
338
|
+
|
|
339
|
+
###### `filePath`<sup>Required</sup> <a name="filePath" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.tryRemoveFile.parameter.filePath"></a>
|
|
340
|
+
|
|
341
|
+
- *Type:* string
|
|
342
|
+
|
|
343
|
+
The file path.
|
|
344
|
+
|
|
345
|
+
If this path is relative, it will be
|
|
346
|
+
resolved from the root of _this_ project.
|
|
347
|
+
|
|
348
|
+
---
|
|
349
|
+
|
|
350
|
+
##### `addBins` <a name="addBins" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addBins"></a>
|
|
351
|
+
|
|
352
|
+
```typescript
|
|
353
|
+
public addBins(bins: {[ key: string ]: string}): void
|
|
354
|
+
```
|
|
355
|
+
|
|
356
|
+
###### `bins`<sup>Required</sup> <a name="bins" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addBins.parameter.bins"></a>
|
|
357
|
+
|
|
358
|
+
- *Type:* {[ key: string ]: string}
|
|
359
|
+
|
|
360
|
+
---
|
|
361
|
+
|
|
362
|
+
##### `addBundledDeps` <a name="addBundledDeps" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addBundledDeps"></a>
|
|
363
|
+
|
|
364
|
+
```typescript
|
|
365
|
+
public addBundledDeps(deps: ...string[]): void
|
|
366
|
+
```
|
|
367
|
+
|
|
368
|
+
Defines bundled dependencies.
|
|
369
|
+
|
|
370
|
+
Bundled dependencies will be added as normal dependencies as well as to the
|
|
371
|
+
`bundledDependencies` section of your `package.json`.
|
|
372
|
+
|
|
373
|
+
###### `deps`<sup>Required</sup> <a name="deps" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addBundledDeps.parameter.deps"></a>
|
|
374
|
+
|
|
375
|
+
- *Type:* ...string[]
|
|
376
|
+
|
|
377
|
+
Names modules to install.
|
|
378
|
+
|
|
379
|
+
By default, the the dependency will
|
|
380
|
+
be installed in the next `npx projen` run and the version will be recorded
|
|
381
|
+
in your `package.json` file. You can upgrade manually or using `yarn
|
|
382
|
+
add/upgrade`. If you wish to specify a version range use this syntax:
|
|
383
|
+
`module@^7`.
|
|
384
|
+
|
|
385
|
+
---
|
|
386
|
+
|
|
387
|
+
##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addCompileCommand"></a>
|
|
388
|
+
|
|
389
|
+
```typescript
|
|
390
|
+
public addCompileCommand(commands: ...string[]): void
|
|
391
|
+
```
|
|
392
|
+
|
|
393
|
+
DEPRECATED.
|
|
394
|
+
|
|
395
|
+
###### `commands`<sup>Required</sup> <a name="commands" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addCompileCommand.parameter.commands"></a>
|
|
396
|
+
|
|
397
|
+
- *Type:* ...string[]
|
|
398
|
+
|
|
399
|
+
---
|
|
400
|
+
|
|
401
|
+
##### `addDeps` <a name="addDeps" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addDeps"></a>
|
|
402
|
+
|
|
403
|
+
```typescript
|
|
404
|
+
public addDeps(deps: ...string[]): void
|
|
405
|
+
```
|
|
406
|
+
|
|
407
|
+
Defines normal dependencies.
|
|
408
|
+
|
|
409
|
+
###### `deps`<sup>Required</sup> <a name="deps" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addDeps.parameter.deps"></a>
|
|
410
|
+
|
|
411
|
+
- *Type:* ...string[]
|
|
412
|
+
|
|
413
|
+
Names modules to install.
|
|
414
|
+
|
|
415
|
+
By default, the the dependency will
|
|
416
|
+
be installed in the next `npx projen` run and the version will be recorded
|
|
417
|
+
in your `package.json` file. You can upgrade manually or using `yarn
|
|
418
|
+
add/upgrade`. If you wish to specify a version range use this syntax:
|
|
419
|
+
`module@^7`.
|
|
420
|
+
|
|
421
|
+
---
|
|
422
|
+
|
|
423
|
+
##### `addDevDeps` <a name="addDevDeps" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addDevDeps"></a>
|
|
424
|
+
|
|
425
|
+
```typescript
|
|
426
|
+
public addDevDeps(deps: ...string[]): void
|
|
427
|
+
```
|
|
428
|
+
|
|
429
|
+
Defines development/test dependencies.
|
|
430
|
+
|
|
431
|
+
###### `deps`<sup>Required</sup> <a name="deps" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addDevDeps.parameter.deps"></a>
|
|
432
|
+
|
|
433
|
+
- *Type:* ...string[]
|
|
434
|
+
|
|
435
|
+
Names modules to install.
|
|
436
|
+
|
|
437
|
+
By default, the the dependency will
|
|
438
|
+
be installed in the next `npx projen` run and the version will be recorded
|
|
439
|
+
in your `package.json` file. You can upgrade manually or using `yarn
|
|
440
|
+
add/upgrade`. If you wish to specify a version range use this syntax:
|
|
441
|
+
`module@^7`.
|
|
442
|
+
|
|
443
|
+
---
|
|
444
|
+
|
|
445
|
+
##### `addFields` <a name="addFields" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addFields"></a>
|
|
446
|
+
|
|
447
|
+
```typescript
|
|
448
|
+
public addFields(fields: {[ key: string ]: any}): void
|
|
449
|
+
```
|
|
450
|
+
|
|
451
|
+
Directly set fields in `package.json`.
|
|
452
|
+
|
|
453
|
+
###### `fields`<sup>Required</sup> <a name="fields" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addFields.parameter.fields"></a>
|
|
454
|
+
|
|
455
|
+
- *Type:* {[ key: string ]: any}
|
|
456
|
+
|
|
457
|
+
The fields to set.
|
|
458
|
+
|
|
459
|
+
---
|
|
460
|
+
|
|
461
|
+
##### `addKeywords` <a name="addKeywords" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addKeywords"></a>
|
|
462
|
+
|
|
463
|
+
```typescript
|
|
464
|
+
public addKeywords(keywords: ...string[]): void
|
|
465
|
+
```
|
|
466
|
+
|
|
467
|
+
Adds keywords to package.json (deduplicated).
|
|
468
|
+
|
|
469
|
+
###### `keywords`<sup>Required</sup> <a name="keywords" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addKeywords.parameter.keywords"></a>
|
|
470
|
+
|
|
471
|
+
- *Type:* ...string[]
|
|
472
|
+
|
|
473
|
+
The keywords to add.
|
|
474
|
+
|
|
475
|
+
---
|
|
476
|
+
|
|
477
|
+
##### `addPeerDeps` <a name="addPeerDeps" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addPeerDeps"></a>
|
|
478
|
+
|
|
479
|
+
```typescript
|
|
480
|
+
public addPeerDeps(deps: ...string[]): void
|
|
481
|
+
```
|
|
482
|
+
|
|
483
|
+
Defines peer dependencies.
|
|
484
|
+
|
|
485
|
+
When adding peer dependencies, a devDependency will also be added on the
|
|
486
|
+
pinned version of the declared peer. This will ensure that you are testing
|
|
487
|
+
your code against the minimum version required from your consumers.
|
|
488
|
+
|
|
489
|
+
###### `deps`<sup>Required</sup> <a name="deps" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addPeerDeps.parameter.deps"></a>
|
|
490
|
+
|
|
491
|
+
- *Type:* ...string[]
|
|
492
|
+
|
|
493
|
+
Names modules to install.
|
|
494
|
+
|
|
495
|
+
By default, the the dependency will
|
|
496
|
+
be installed in the next `npx projen` run and the version will be recorded
|
|
497
|
+
in your `package.json` file. You can upgrade manually or using `yarn
|
|
498
|
+
add/upgrade`. If you wish to specify a version range use this syntax:
|
|
499
|
+
`module@^7`.
|
|
500
|
+
|
|
501
|
+
---
|
|
502
|
+
|
|
503
|
+
##### `addScripts` <a name="addScripts" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addScripts"></a>
|
|
504
|
+
|
|
505
|
+
```typescript
|
|
506
|
+
public addScripts(scripts: {[ key: string ]: string}): void
|
|
507
|
+
```
|
|
508
|
+
|
|
509
|
+
Replaces the contents of multiple npm package.json scripts.
|
|
510
|
+
|
|
511
|
+
###### `scripts`<sup>Required</sup> <a name="scripts" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addScripts.parameter.scripts"></a>
|
|
512
|
+
|
|
513
|
+
- *Type:* {[ key: string ]: string}
|
|
514
|
+
|
|
515
|
+
The scripts to set.
|
|
516
|
+
|
|
517
|
+
---
|
|
518
|
+
|
|
519
|
+
##### ~~`addTestCommand`~~ <a name="addTestCommand" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addTestCommand"></a>
|
|
520
|
+
|
|
521
|
+
```typescript
|
|
522
|
+
public addTestCommand(commands: ...string[]): void
|
|
523
|
+
```
|
|
524
|
+
|
|
525
|
+
DEPRECATED.
|
|
526
|
+
|
|
527
|
+
###### `commands`<sup>Required</sup> <a name="commands" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addTestCommand.parameter.commands"></a>
|
|
528
|
+
|
|
529
|
+
- *Type:* ...string[]
|
|
530
|
+
|
|
531
|
+
---
|
|
532
|
+
|
|
533
|
+
##### ~~`hasScript`~~ <a name="hasScript" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.hasScript"></a>
|
|
534
|
+
|
|
535
|
+
```typescript
|
|
536
|
+
public hasScript(name: string): boolean
|
|
537
|
+
```
|
|
538
|
+
|
|
539
|
+
Indicates if a script by the name name is defined.
|
|
540
|
+
|
|
541
|
+
###### `name`<sup>Required</sup> <a name="name" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.hasScript.parameter.name"></a>
|
|
542
|
+
|
|
543
|
+
- *Type:* string
|
|
544
|
+
|
|
545
|
+
The name of the script.
|
|
546
|
+
|
|
547
|
+
---
|
|
548
|
+
|
|
549
|
+
##### `removeScript` <a name="removeScript" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.removeScript"></a>
|
|
550
|
+
|
|
551
|
+
```typescript
|
|
552
|
+
public removeScript(name: string): void
|
|
553
|
+
```
|
|
554
|
+
|
|
555
|
+
Removes the npm script (always successful).
|
|
556
|
+
|
|
557
|
+
###### `name`<sup>Required</sup> <a name="name" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.removeScript.parameter.name"></a>
|
|
558
|
+
|
|
559
|
+
- *Type:* string
|
|
560
|
+
|
|
561
|
+
The name of the script.
|
|
562
|
+
|
|
563
|
+
---
|
|
564
|
+
|
|
565
|
+
##### `renderWorkflowSetup` <a name="renderWorkflowSetup" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.renderWorkflowSetup"></a>
|
|
566
|
+
|
|
567
|
+
```typescript
|
|
568
|
+
public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[]
|
|
569
|
+
```
|
|
570
|
+
|
|
571
|
+
Returns the set of workflow steps which should be executed to bootstrap a workflow.
|
|
572
|
+
|
|
573
|
+
###### `options`<sup>Optional</sup> <a name="options" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.renderWorkflowSetup.parameter.options"></a>
|
|
574
|
+
|
|
575
|
+
- *Type:* projen.javascript.RenderWorkflowSetupOptions
|
|
576
|
+
|
|
577
|
+
Options.
|
|
578
|
+
|
|
579
|
+
---
|
|
580
|
+
|
|
581
|
+
##### `setScript` <a name="setScript" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.setScript"></a>
|
|
582
|
+
|
|
583
|
+
```typescript
|
|
584
|
+
public setScript(name: string, command: string): void
|
|
585
|
+
```
|
|
586
|
+
|
|
587
|
+
Replaces the contents of an npm package.json script.
|
|
588
|
+
|
|
589
|
+
###### `name`<sup>Required</sup> <a name="name" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.setScript.parameter.name"></a>
|
|
590
|
+
|
|
591
|
+
- *Type:* string
|
|
592
|
+
|
|
593
|
+
The script name.
|
|
594
|
+
|
|
595
|
+
---
|
|
596
|
+
|
|
597
|
+
###### `command`<sup>Required</sup> <a name="command" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.setScript.parameter.command"></a>
|
|
598
|
+
|
|
599
|
+
- *Type:* string
|
|
600
|
+
|
|
601
|
+
The command to execute.
|
|
602
|
+
|
|
603
|
+
---
|
|
604
|
+
|
|
605
|
+
##### ~~`addCdkDependencies`~~ <a name="addCdkDependencies" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addCdkDependencies"></a>
|
|
606
|
+
|
|
607
|
+
```typescript
|
|
608
|
+
public addCdkDependencies(deps: ...string[]): void
|
|
609
|
+
```
|
|
610
|
+
|
|
611
|
+
Adds dependencies to AWS CDK modules.
|
|
612
|
+
|
|
613
|
+
Since this is a library project, dependencies will be added as peer dependencies.
|
|
614
|
+
|
|
615
|
+
###### `deps`<sup>Required</sup> <a name="deps" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addCdkDependencies.parameter.deps"></a>
|
|
616
|
+
|
|
617
|
+
- *Type:* ...string[]
|
|
618
|
+
|
|
619
|
+
names of cdk modules (e.g. `@aws-cdk/aws-lambda`).
|
|
620
|
+
|
|
621
|
+
---
|
|
622
|
+
|
|
623
|
+
##### ~~`addCdkTestDependencies`~~ <a name="addCdkTestDependencies" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addCdkTestDependencies"></a>
|
|
624
|
+
|
|
625
|
+
```typescript
|
|
626
|
+
public addCdkTestDependencies(deps: ...string[]): void
|
|
627
|
+
```
|
|
628
|
+
|
|
629
|
+
Adds AWS CDK modules as dev dependencies.
|
|
630
|
+
|
|
631
|
+
###### `deps`<sup>Required</sup> <a name="deps" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.addCdkTestDependencies.parameter.deps"></a>
|
|
632
|
+
|
|
633
|
+
- *Type:* ...string[]
|
|
634
|
+
|
|
635
|
+
names of cdk modules (e.g. `@aws-cdk/aws-lambda`).
|
|
636
|
+
|
|
637
|
+
---
|
|
638
|
+
|
|
639
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
640
|
+
|
|
641
|
+
| **Name** | **Description** |
|
|
642
|
+
| --- | --- |
|
|
643
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
644
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.isProject">isProject</a></code> | Test whether the given construct is a project. |
|
|
645
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.of">of</a></code> | Find the closest ancestor project for given construct. |
|
|
646
|
+
|
|
647
|
+
---
|
|
648
|
+
|
|
649
|
+
##### `isConstruct` <a name="isConstruct" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.isConstruct"></a>
|
|
650
|
+
|
|
651
|
+
```typescript
|
|
652
|
+
import { AlmaCdkConstructLibrary } from '@alma-cdk/construct-library'
|
|
653
|
+
|
|
654
|
+
AlmaCdkConstructLibrary.isConstruct(x: any)
|
|
655
|
+
```
|
|
656
|
+
|
|
657
|
+
Checks if `x` is a construct.
|
|
658
|
+
|
|
659
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
660
|
+
instances, even when the construct library is symlinked.
|
|
661
|
+
|
|
662
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
663
|
+
disk are seen as independent, completely different libraries. As a
|
|
664
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
665
|
+
is seen as a different class, and an instance of one class will not test as
|
|
666
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
667
|
+
like this, but users may manually symlink construct libraries together or
|
|
668
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
669
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
670
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
671
|
+
this type-testing method instead.
|
|
672
|
+
|
|
673
|
+
###### `x`<sup>Required</sup> <a name="x" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.isConstruct.parameter.x"></a>
|
|
674
|
+
|
|
675
|
+
- *Type:* any
|
|
676
|
+
|
|
677
|
+
Any object.
|
|
678
|
+
|
|
679
|
+
---
|
|
680
|
+
|
|
681
|
+
##### `isProject` <a name="isProject" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.isProject"></a>
|
|
682
|
+
|
|
683
|
+
```typescript
|
|
684
|
+
import { AlmaCdkConstructLibrary } from '@alma-cdk/construct-library'
|
|
685
|
+
|
|
686
|
+
AlmaCdkConstructLibrary.isProject(x: any)
|
|
687
|
+
```
|
|
688
|
+
|
|
689
|
+
Test whether the given construct is a project.
|
|
690
|
+
|
|
691
|
+
###### `x`<sup>Required</sup> <a name="x" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.isProject.parameter.x"></a>
|
|
692
|
+
|
|
693
|
+
- *Type:* any
|
|
694
|
+
|
|
695
|
+
---
|
|
696
|
+
|
|
697
|
+
##### `of` <a name="of" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.of"></a>
|
|
698
|
+
|
|
699
|
+
```typescript
|
|
700
|
+
import { AlmaCdkConstructLibrary } from '@alma-cdk/construct-library'
|
|
701
|
+
|
|
702
|
+
AlmaCdkConstructLibrary.of(construct: IConstruct)
|
|
703
|
+
```
|
|
704
|
+
|
|
705
|
+
Find the closest ancestor project for given construct.
|
|
706
|
+
|
|
707
|
+
When given a project, this it the project itself.
|
|
708
|
+
|
|
709
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.of.parameter.construct"></a>
|
|
710
|
+
|
|
711
|
+
- *Type:* constructs.IConstruct
|
|
712
|
+
|
|
713
|
+
---
|
|
714
|
+
|
|
715
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
716
|
+
|
|
717
|
+
| **Name** | **Type** | **Description** |
|
|
718
|
+
| --- | --- | --- |
|
|
719
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
720
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.buildTask">buildTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
721
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
|
722
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.compileTask">compileTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
723
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.components">components</a></code> | <code>projen.Component[]</code> | Returns all the components within this project. |
|
|
724
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.deps">deps</a></code> | <code>projen.Dependencies</code> | Project dependencies. |
|
|
725
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.ejected">ejected</a></code> | <code>boolean</code> | Whether or not the project is being ejected. |
|
|
726
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.files">files</a></code> | <code>projen.FileBase[]</code> | All files in this project. |
|
|
727
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.gitattributes">gitattributes</a></code> | <code>projen.GitAttributesFile</code> | The .gitattributes file for this repository. |
|
|
728
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.gitignore">gitignore</a></code> | <code>projen.IgnoreFile</code> | .gitignore. |
|
|
729
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.logger">logger</a></code> | <code>projen.Logger</code> | Logging utilities. |
|
|
730
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.name">name</a></code> | <code>string</code> | Project name. |
|
|
731
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.outdir">outdir</a></code> | <code>string</code> | Absolute output directory of this project. |
|
|
732
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.packageTask">packageTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
733
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.postCompileTask">postCompileTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
734
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.preCompileTask">preCompileTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
735
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.projectBuild">projectBuild</a></code> | <code>projen.ProjectBuild</code> | Manages the build process of the project. |
|
|
736
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.projenCommand">projenCommand</a></code> | <code>string</code> | The command to use in order to run the projen CLI. |
|
|
737
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.root">root</a></code> | <code>projen.Project</code> | The root project. |
|
|
738
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.subprojects">subprojects</a></code> | <code>projen.Project[]</code> | Returns all the subprojects within this project. |
|
|
739
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.tasks">tasks</a></code> | <code>projen.Tasks</code> | Project tasks. |
|
|
740
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.testTask">testTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
741
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
|
|
742
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.initProject">initProject</a></code> | <code>projen.InitProject</code> | The options used when this project is bootstrapped via `projen new`. |
|
|
743
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.parent">parent</a></code> | <code>projen.Project</code> | A parent project. |
|
|
744
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | *No description.* |
|
|
745
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.autoApprove">autoApprove</a></code> | <code>projen.github.AutoApprove</code> | Auto approve set up for this project. |
|
|
746
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.devContainer">devContainer</a></code> | <code>projen.vscode.DevContainer</code> | Access for .devcontainer.json (used for GitHub Codespaces). |
|
|
747
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.github">github</a></code> | <code>projen.github.GitHub</code> | Access all github components. |
|
|
748
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.gitpod">gitpod</a></code> | <code>projen.Gitpod</code> | Access for Gitpod. |
|
|
749
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.vscode">vscode</a></code> | <code>projen.vscode.VsCode</code> | Access all VSCode components. |
|
|
750
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | *No description.* |
|
|
751
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | The build output directory. |
|
|
752
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.artifactsJavascriptDirectory">artifactsJavascriptDirectory</a></code> | <code>string</code> | The location of the npm tarball after build (`${artifactsDirectory}/js`). |
|
|
753
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.bundler">bundler</a></code> | <code>projen.javascript.Bundler</code> | *No description.* |
|
|
754
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.entrypoint">entrypoint</a></code> | <code>string</code> | *No description.* |
|
|
755
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.manifest">manifest</a></code> | <code>any</code> | *No description.* |
|
|
756
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.npmrc">npmrc</a></code> | <code>projen.javascript.NpmConfig</code> | The .npmrc file. |
|
|
757
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.package">package</a></code> | <code>projen.javascript.NodePackage</code> | API for managing the node package. |
|
|
758
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
|
|
759
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.runScriptCommand">runScriptCommand</a></code> | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
|
|
760
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
|
|
761
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
|
|
762
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
|
|
763
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
|
|
764
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
|
|
765
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version supported by this package. |
|
|
766
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
|
|
767
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
|
|
768
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
|
|
769
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
|
|
770
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.release">release</a></code> | <code>projen.release.Release</code> | Release management. |
|
|
771
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
|
|
772
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
|
|
773
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
|
|
774
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
|
|
775
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
|
|
776
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfig</code> | A typescript configuration file which covers all files (sources, tests, projen). |
|
|
777
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.watchTask">watchTask</a></code> | <code>projen.Task</code> | The "watch" task. |
|
|
778
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.docgen">docgen</a></code> | <code>boolean</code> | *No description.* |
|
|
779
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.eslint">eslint</a></code> | <code>projen.javascript.Eslint</code> | *No description.* |
|
|
780
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
|
|
781
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.tsconfigEslint">tsconfigEslint</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
|
|
782
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.cdkDeps">cdkDeps</a></code> | <code>projen.awscdk.AwsCdkDeps</code> | *No description.* |
|
|
783
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.cdkVersion">cdkVersion</a></code> | <code>string</code> | The target CDK version for this library. |
|
|
784
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.version">version</a></code> | <code>string</code> | *No description.* |
|
|
785
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | *No description.* |
|
|
786
|
+
|
|
787
|
+
---
|
|
788
|
+
|
|
789
|
+
##### `node`<sup>Required</sup> <a name="node" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.node"></a>
|
|
790
|
+
|
|
791
|
+
```typescript
|
|
792
|
+
public readonly node: Node;
|
|
793
|
+
```
|
|
794
|
+
|
|
795
|
+
- *Type:* constructs.Node
|
|
796
|
+
|
|
797
|
+
The tree node.
|
|
798
|
+
|
|
799
|
+
---
|
|
800
|
+
|
|
801
|
+
##### `buildTask`<sup>Required</sup> <a name="buildTask" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.buildTask"></a>
|
|
802
|
+
|
|
803
|
+
```typescript
|
|
804
|
+
public readonly buildTask: Task;
|
|
805
|
+
```
|
|
806
|
+
|
|
807
|
+
- *Type:* projen.Task
|
|
808
|
+
|
|
809
|
+
---
|
|
810
|
+
|
|
811
|
+
##### `commitGenerated`<sup>Required</sup> <a name="commitGenerated" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.commitGenerated"></a>
|
|
812
|
+
|
|
813
|
+
```typescript
|
|
814
|
+
public readonly commitGenerated: boolean;
|
|
815
|
+
```
|
|
816
|
+
|
|
817
|
+
- *Type:* boolean
|
|
818
|
+
|
|
819
|
+
Whether to commit the managed files by default.
|
|
820
|
+
|
|
821
|
+
---
|
|
822
|
+
|
|
823
|
+
##### `compileTask`<sup>Required</sup> <a name="compileTask" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.compileTask"></a>
|
|
824
|
+
|
|
825
|
+
```typescript
|
|
826
|
+
public readonly compileTask: Task;
|
|
827
|
+
```
|
|
828
|
+
|
|
829
|
+
- *Type:* projen.Task
|
|
830
|
+
|
|
831
|
+
---
|
|
832
|
+
|
|
833
|
+
##### `components`<sup>Required</sup> <a name="components" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.components"></a>
|
|
834
|
+
|
|
835
|
+
```typescript
|
|
836
|
+
public readonly components: Component[];
|
|
837
|
+
```
|
|
838
|
+
|
|
839
|
+
- *Type:* projen.Component[]
|
|
840
|
+
|
|
841
|
+
Returns all the components within this project.
|
|
842
|
+
|
|
843
|
+
---
|
|
844
|
+
|
|
845
|
+
##### `deps`<sup>Required</sup> <a name="deps" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.deps"></a>
|
|
846
|
+
|
|
847
|
+
```typescript
|
|
848
|
+
public readonly deps: Dependencies;
|
|
849
|
+
```
|
|
850
|
+
|
|
851
|
+
- *Type:* projen.Dependencies
|
|
852
|
+
|
|
853
|
+
Project dependencies.
|
|
854
|
+
|
|
855
|
+
---
|
|
856
|
+
|
|
857
|
+
##### `ejected`<sup>Required</sup> <a name="ejected" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.ejected"></a>
|
|
858
|
+
|
|
859
|
+
```typescript
|
|
860
|
+
public readonly ejected: boolean;
|
|
861
|
+
```
|
|
862
|
+
|
|
863
|
+
- *Type:* boolean
|
|
864
|
+
|
|
865
|
+
Whether or not the project is being ejected.
|
|
866
|
+
|
|
867
|
+
---
|
|
868
|
+
|
|
869
|
+
##### `files`<sup>Required</sup> <a name="files" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.files"></a>
|
|
870
|
+
|
|
871
|
+
```typescript
|
|
872
|
+
public readonly files: FileBase[];
|
|
873
|
+
```
|
|
874
|
+
|
|
875
|
+
- *Type:* projen.FileBase[]
|
|
876
|
+
|
|
877
|
+
All files in this project.
|
|
878
|
+
|
|
879
|
+
---
|
|
880
|
+
|
|
881
|
+
##### `gitattributes`<sup>Required</sup> <a name="gitattributes" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.gitattributes"></a>
|
|
882
|
+
|
|
883
|
+
```typescript
|
|
884
|
+
public readonly gitattributes: GitAttributesFile;
|
|
885
|
+
```
|
|
886
|
+
|
|
887
|
+
- *Type:* projen.GitAttributesFile
|
|
888
|
+
|
|
889
|
+
The .gitattributes file for this repository.
|
|
890
|
+
|
|
891
|
+
---
|
|
892
|
+
|
|
893
|
+
##### `gitignore`<sup>Required</sup> <a name="gitignore" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.gitignore"></a>
|
|
894
|
+
|
|
895
|
+
```typescript
|
|
896
|
+
public readonly gitignore: IgnoreFile;
|
|
897
|
+
```
|
|
898
|
+
|
|
899
|
+
- *Type:* projen.IgnoreFile
|
|
900
|
+
|
|
901
|
+
.gitignore.
|
|
902
|
+
|
|
903
|
+
---
|
|
904
|
+
|
|
905
|
+
##### `logger`<sup>Required</sup> <a name="logger" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.logger"></a>
|
|
906
|
+
|
|
907
|
+
```typescript
|
|
908
|
+
public readonly logger: Logger;
|
|
909
|
+
```
|
|
910
|
+
|
|
911
|
+
- *Type:* projen.Logger
|
|
912
|
+
|
|
913
|
+
Logging utilities.
|
|
914
|
+
|
|
915
|
+
---
|
|
916
|
+
|
|
917
|
+
##### `name`<sup>Required</sup> <a name="name" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.name"></a>
|
|
918
|
+
|
|
919
|
+
```typescript
|
|
920
|
+
public readonly name: string;
|
|
921
|
+
```
|
|
922
|
+
|
|
923
|
+
- *Type:* string
|
|
924
|
+
|
|
925
|
+
Project name.
|
|
926
|
+
|
|
927
|
+
---
|
|
928
|
+
|
|
929
|
+
##### `outdir`<sup>Required</sup> <a name="outdir" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.outdir"></a>
|
|
930
|
+
|
|
931
|
+
```typescript
|
|
932
|
+
public readonly outdir: string;
|
|
933
|
+
```
|
|
934
|
+
|
|
935
|
+
- *Type:* string
|
|
936
|
+
|
|
937
|
+
Absolute output directory of this project.
|
|
938
|
+
|
|
939
|
+
---
|
|
940
|
+
|
|
941
|
+
##### `packageTask`<sup>Required</sup> <a name="packageTask" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.packageTask"></a>
|
|
942
|
+
|
|
943
|
+
```typescript
|
|
944
|
+
public readonly packageTask: Task;
|
|
945
|
+
```
|
|
946
|
+
|
|
947
|
+
- *Type:* projen.Task
|
|
948
|
+
|
|
949
|
+
---
|
|
950
|
+
|
|
951
|
+
##### `postCompileTask`<sup>Required</sup> <a name="postCompileTask" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.postCompileTask"></a>
|
|
952
|
+
|
|
953
|
+
```typescript
|
|
954
|
+
public readonly postCompileTask: Task;
|
|
955
|
+
```
|
|
956
|
+
|
|
957
|
+
- *Type:* projen.Task
|
|
958
|
+
|
|
959
|
+
---
|
|
960
|
+
|
|
961
|
+
##### `preCompileTask`<sup>Required</sup> <a name="preCompileTask" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.preCompileTask"></a>
|
|
962
|
+
|
|
963
|
+
```typescript
|
|
964
|
+
public readonly preCompileTask: Task;
|
|
965
|
+
```
|
|
966
|
+
|
|
967
|
+
- *Type:* projen.Task
|
|
968
|
+
|
|
969
|
+
---
|
|
970
|
+
|
|
971
|
+
##### `projectBuild`<sup>Required</sup> <a name="projectBuild" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.projectBuild"></a>
|
|
972
|
+
|
|
973
|
+
```typescript
|
|
974
|
+
public readonly projectBuild: ProjectBuild;
|
|
975
|
+
```
|
|
976
|
+
|
|
977
|
+
- *Type:* projen.ProjectBuild
|
|
978
|
+
|
|
979
|
+
Manages the build process of the project.
|
|
980
|
+
|
|
981
|
+
---
|
|
982
|
+
|
|
983
|
+
##### `projenCommand`<sup>Required</sup> <a name="projenCommand" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.projenCommand"></a>
|
|
984
|
+
|
|
985
|
+
```typescript
|
|
986
|
+
public readonly projenCommand: string;
|
|
987
|
+
```
|
|
988
|
+
|
|
989
|
+
- *Type:* string
|
|
990
|
+
|
|
991
|
+
The command to use in order to run the projen CLI.
|
|
992
|
+
|
|
993
|
+
---
|
|
994
|
+
|
|
995
|
+
##### `root`<sup>Required</sup> <a name="root" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.root"></a>
|
|
996
|
+
|
|
997
|
+
```typescript
|
|
998
|
+
public readonly root: Project;
|
|
999
|
+
```
|
|
1000
|
+
|
|
1001
|
+
- *Type:* projen.Project
|
|
1002
|
+
|
|
1003
|
+
The root project.
|
|
1004
|
+
|
|
1005
|
+
---
|
|
1006
|
+
|
|
1007
|
+
##### `subprojects`<sup>Required</sup> <a name="subprojects" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.subprojects"></a>
|
|
1008
|
+
|
|
1009
|
+
```typescript
|
|
1010
|
+
public readonly subprojects: Project[];
|
|
1011
|
+
```
|
|
1012
|
+
|
|
1013
|
+
- *Type:* projen.Project[]
|
|
1014
|
+
|
|
1015
|
+
Returns all the subprojects within this project.
|
|
1016
|
+
|
|
1017
|
+
---
|
|
1018
|
+
|
|
1019
|
+
##### `tasks`<sup>Required</sup> <a name="tasks" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.tasks"></a>
|
|
1020
|
+
|
|
1021
|
+
```typescript
|
|
1022
|
+
public readonly tasks: Tasks;
|
|
1023
|
+
```
|
|
1024
|
+
|
|
1025
|
+
- *Type:* projen.Tasks
|
|
1026
|
+
|
|
1027
|
+
Project tasks.
|
|
1028
|
+
|
|
1029
|
+
---
|
|
1030
|
+
|
|
1031
|
+
##### `testTask`<sup>Required</sup> <a name="testTask" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.testTask"></a>
|
|
1032
|
+
|
|
1033
|
+
```typescript
|
|
1034
|
+
public readonly testTask: Task;
|
|
1035
|
+
```
|
|
1036
|
+
|
|
1037
|
+
- *Type:* projen.Task
|
|
1038
|
+
|
|
1039
|
+
---
|
|
1040
|
+
|
|
1041
|
+
##### `defaultTask`<sup>Optional</sup> <a name="defaultTask" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.defaultTask"></a>
|
|
1042
|
+
|
|
1043
|
+
```typescript
|
|
1044
|
+
public readonly defaultTask: Task;
|
|
1045
|
+
```
|
|
1046
|
+
|
|
1047
|
+
- *Type:* projen.Task
|
|
1048
|
+
|
|
1049
|
+
This is the "default" task, the one that executes "projen".
|
|
1050
|
+
|
|
1051
|
+
Undefined if
|
|
1052
|
+
the project is being ejected.
|
|
1053
|
+
|
|
1054
|
+
---
|
|
1055
|
+
|
|
1056
|
+
##### `initProject`<sup>Optional</sup> <a name="initProject" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.initProject"></a>
|
|
1057
|
+
|
|
1058
|
+
```typescript
|
|
1059
|
+
public readonly initProject: InitProject;
|
|
1060
|
+
```
|
|
1061
|
+
|
|
1062
|
+
- *Type:* projen.InitProject
|
|
1063
|
+
|
|
1064
|
+
The options used when this project is bootstrapped via `projen new`.
|
|
1065
|
+
|
|
1066
|
+
It
|
|
1067
|
+
includes the original set of options passed to the CLI and also the JSII
|
|
1068
|
+
FQN of the project type.
|
|
1069
|
+
|
|
1070
|
+
---
|
|
1071
|
+
|
|
1072
|
+
##### `parent`<sup>Optional</sup> <a name="parent" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.parent"></a>
|
|
1073
|
+
|
|
1074
|
+
```typescript
|
|
1075
|
+
public readonly parent: Project;
|
|
1076
|
+
```
|
|
1077
|
+
|
|
1078
|
+
- *Type:* projen.Project
|
|
1079
|
+
|
|
1080
|
+
A parent project.
|
|
1081
|
+
|
|
1082
|
+
If undefined, this is the root project.
|
|
1083
|
+
|
|
1084
|
+
---
|
|
1085
|
+
|
|
1086
|
+
##### `projectType`<sup>Required</sup> <a name="projectType" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.projectType"></a>
|
|
1087
|
+
|
|
1088
|
+
```typescript
|
|
1089
|
+
public readonly projectType: ProjectType;
|
|
1090
|
+
```
|
|
1091
|
+
|
|
1092
|
+
- *Type:* projen.ProjectType
|
|
1093
|
+
|
|
1094
|
+
---
|
|
1095
|
+
|
|
1096
|
+
##### `autoApprove`<sup>Optional</sup> <a name="autoApprove" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.autoApprove"></a>
|
|
1097
|
+
|
|
1098
|
+
```typescript
|
|
1099
|
+
public readonly autoApprove: AutoApprove;
|
|
1100
|
+
```
|
|
1101
|
+
|
|
1102
|
+
- *Type:* projen.github.AutoApprove
|
|
1103
|
+
|
|
1104
|
+
Auto approve set up for this project.
|
|
1105
|
+
|
|
1106
|
+
---
|
|
1107
|
+
|
|
1108
|
+
##### `devContainer`<sup>Optional</sup> <a name="devContainer" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.devContainer"></a>
|
|
1109
|
+
|
|
1110
|
+
```typescript
|
|
1111
|
+
public readonly devContainer: DevContainer;
|
|
1112
|
+
```
|
|
1113
|
+
|
|
1114
|
+
- *Type:* projen.vscode.DevContainer
|
|
1115
|
+
|
|
1116
|
+
Access for .devcontainer.json (used for GitHub Codespaces).
|
|
1117
|
+
|
|
1118
|
+
This will be `undefined` if devContainer boolean is false
|
|
1119
|
+
|
|
1120
|
+
---
|
|
1121
|
+
|
|
1122
|
+
##### `github`<sup>Optional</sup> <a name="github" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.github"></a>
|
|
1123
|
+
|
|
1124
|
+
```typescript
|
|
1125
|
+
public readonly github: GitHub;
|
|
1126
|
+
```
|
|
1127
|
+
|
|
1128
|
+
- *Type:* projen.github.GitHub
|
|
1129
|
+
|
|
1130
|
+
Access all github components.
|
|
1131
|
+
|
|
1132
|
+
This will be `undefined` for subprojects.
|
|
1133
|
+
|
|
1134
|
+
---
|
|
1135
|
+
|
|
1136
|
+
##### `gitpod`<sup>Optional</sup> <a name="gitpod" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.gitpod"></a>
|
|
1137
|
+
|
|
1138
|
+
```typescript
|
|
1139
|
+
public readonly gitpod: Gitpod;
|
|
1140
|
+
```
|
|
1141
|
+
|
|
1142
|
+
- *Type:* projen.Gitpod
|
|
1143
|
+
|
|
1144
|
+
Access for Gitpod.
|
|
1145
|
+
|
|
1146
|
+
This will be `undefined` if gitpod boolean is false
|
|
1147
|
+
|
|
1148
|
+
---
|
|
1149
|
+
|
|
1150
|
+
##### `vscode`<sup>Optional</sup> <a name="vscode" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.vscode"></a>
|
|
1151
|
+
|
|
1152
|
+
```typescript
|
|
1153
|
+
public readonly vscode: VsCode;
|
|
1154
|
+
```
|
|
1155
|
+
|
|
1156
|
+
- *Type:* projen.vscode.VsCode
|
|
1157
|
+
|
|
1158
|
+
Access all VSCode components.
|
|
1159
|
+
|
|
1160
|
+
This will be `undefined` for subprojects.
|
|
1161
|
+
|
|
1162
|
+
---
|
|
1163
|
+
|
|
1164
|
+
##### ~~`allowLibraryDependencies`~~<sup>Required</sup> <a name="allowLibraryDependencies" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.allowLibraryDependencies"></a>
|
|
1165
|
+
|
|
1166
|
+
- *Deprecated:* use `package.allowLibraryDependencies`
|
|
1167
|
+
|
|
1168
|
+
```typescript
|
|
1169
|
+
public readonly allowLibraryDependencies: boolean;
|
|
1170
|
+
```
|
|
1171
|
+
|
|
1172
|
+
- *Type:* boolean
|
|
1173
|
+
|
|
1174
|
+
---
|
|
1175
|
+
|
|
1176
|
+
##### `artifactsDirectory`<sup>Required</sup> <a name="artifactsDirectory" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.artifactsDirectory"></a>
|
|
1177
|
+
|
|
1178
|
+
```typescript
|
|
1179
|
+
public readonly artifactsDirectory: string;
|
|
1180
|
+
```
|
|
1181
|
+
|
|
1182
|
+
- *Type:* string
|
|
1183
|
+
|
|
1184
|
+
The build output directory.
|
|
1185
|
+
|
|
1186
|
+
An npm tarball will be created under the `js`
|
|
1187
|
+
subdirectory. For example, if this is set to `dist` (the default), the npm
|
|
1188
|
+
tarball will be placed under `dist/js/boom-boom-1.2.3.tg`.
|
|
1189
|
+
|
|
1190
|
+
---
|
|
1191
|
+
|
|
1192
|
+
##### `artifactsJavascriptDirectory`<sup>Required</sup> <a name="artifactsJavascriptDirectory" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.artifactsJavascriptDirectory"></a>
|
|
1193
|
+
|
|
1194
|
+
```typescript
|
|
1195
|
+
public readonly artifactsJavascriptDirectory: string;
|
|
1196
|
+
```
|
|
1197
|
+
|
|
1198
|
+
- *Type:* string
|
|
1199
|
+
|
|
1200
|
+
The location of the npm tarball after build (`${artifactsDirectory}/js`).
|
|
1201
|
+
|
|
1202
|
+
---
|
|
1203
|
+
|
|
1204
|
+
##### `bundler`<sup>Required</sup> <a name="bundler" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.bundler"></a>
|
|
1205
|
+
|
|
1206
|
+
```typescript
|
|
1207
|
+
public readonly bundler: Bundler;
|
|
1208
|
+
```
|
|
1209
|
+
|
|
1210
|
+
- *Type:* projen.javascript.Bundler
|
|
1211
|
+
|
|
1212
|
+
---
|
|
1213
|
+
|
|
1214
|
+
##### ~~`entrypoint`~~<sup>Required</sup> <a name="entrypoint" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.entrypoint"></a>
|
|
1215
|
+
|
|
1216
|
+
- *Deprecated:* use `package.entrypoint`
|
|
1217
|
+
|
|
1218
|
+
```typescript
|
|
1219
|
+
public readonly entrypoint: string;
|
|
1220
|
+
```
|
|
1221
|
+
|
|
1222
|
+
- *Type:* string
|
|
1223
|
+
|
|
1224
|
+
---
|
|
1225
|
+
|
|
1226
|
+
##### ~~`manifest`~~<sup>Required</sup> <a name="manifest" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.manifest"></a>
|
|
1227
|
+
|
|
1228
|
+
- *Deprecated:* use `package.addField(x, y)`
|
|
1229
|
+
|
|
1230
|
+
```typescript
|
|
1231
|
+
public readonly manifest: any;
|
|
1232
|
+
```
|
|
1233
|
+
|
|
1234
|
+
- *Type:* any
|
|
1235
|
+
|
|
1236
|
+
---
|
|
1237
|
+
|
|
1238
|
+
##### `npmrc`<sup>Required</sup> <a name="npmrc" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.npmrc"></a>
|
|
1239
|
+
|
|
1240
|
+
```typescript
|
|
1241
|
+
public readonly npmrc: NpmConfig;
|
|
1242
|
+
```
|
|
1243
|
+
|
|
1244
|
+
- *Type:* projen.javascript.NpmConfig
|
|
1245
|
+
|
|
1246
|
+
The .npmrc file.
|
|
1247
|
+
|
|
1248
|
+
---
|
|
1249
|
+
|
|
1250
|
+
##### `package`<sup>Required</sup> <a name="package" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.package"></a>
|
|
1251
|
+
|
|
1252
|
+
```typescript
|
|
1253
|
+
public readonly package: NodePackage;
|
|
1254
|
+
```
|
|
1255
|
+
|
|
1256
|
+
- *Type:* projen.javascript.NodePackage
|
|
1257
|
+
|
|
1258
|
+
API for managing the node package.
|
|
1259
|
+
|
|
1260
|
+
---
|
|
1261
|
+
|
|
1262
|
+
##### ~~`packageManager`~~<sup>Required</sup> <a name="packageManager" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.packageManager"></a>
|
|
1263
|
+
|
|
1264
|
+
- *Deprecated:* use `package.packageManager`
|
|
1265
|
+
|
|
1266
|
+
```typescript
|
|
1267
|
+
public readonly packageManager: NodePackageManager;
|
|
1268
|
+
```
|
|
1269
|
+
|
|
1270
|
+
- *Type:* projen.javascript.NodePackageManager
|
|
1271
|
+
|
|
1272
|
+
The package manager to use.
|
|
1273
|
+
|
|
1274
|
+
---
|
|
1275
|
+
|
|
1276
|
+
##### `runScriptCommand`<sup>Required</sup> <a name="runScriptCommand" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.runScriptCommand"></a>
|
|
1277
|
+
|
|
1278
|
+
```typescript
|
|
1279
|
+
public readonly runScriptCommand: string;
|
|
1280
|
+
```
|
|
1281
|
+
|
|
1282
|
+
- *Type:* string
|
|
1283
|
+
|
|
1284
|
+
The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager).
|
|
1285
|
+
|
|
1286
|
+
---
|
|
1287
|
+
|
|
1288
|
+
##### `autoMerge`<sup>Optional</sup> <a name="autoMerge" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.autoMerge"></a>
|
|
1289
|
+
|
|
1290
|
+
```typescript
|
|
1291
|
+
public readonly autoMerge: AutoMerge;
|
|
1292
|
+
```
|
|
1293
|
+
|
|
1294
|
+
- *Type:* projen.github.AutoMerge
|
|
1295
|
+
|
|
1296
|
+
Component that sets up mergify for merging approved pull requests.
|
|
1297
|
+
|
|
1298
|
+
---
|
|
1299
|
+
|
|
1300
|
+
##### `biome`<sup>Optional</sup> <a name="biome" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.biome"></a>
|
|
1301
|
+
|
|
1302
|
+
```typescript
|
|
1303
|
+
public readonly biome: Biome;
|
|
1304
|
+
```
|
|
1305
|
+
|
|
1306
|
+
- *Type:* projen.javascript.Biome
|
|
1307
|
+
|
|
1308
|
+
---
|
|
1309
|
+
|
|
1310
|
+
##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.buildWorkflow"></a>
|
|
1311
|
+
|
|
1312
|
+
```typescript
|
|
1313
|
+
public readonly buildWorkflow: BuildWorkflow;
|
|
1314
|
+
```
|
|
1315
|
+
|
|
1316
|
+
- *Type:* projen.build.BuildWorkflow
|
|
1317
|
+
|
|
1318
|
+
The PR build GitHub workflow.
|
|
1319
|
+
|
|
1320
|
+
`undefined` if `buildWorkflow` is disabled.
|
|
1321
|
+
|
|
1322
|
+
---
|
|
1323
|
+
|
|
1324
|
+
##### `buildWorkflowJobId`<sup>Optional</sup> <a name="buildWorkflowJobId" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.buildWorkflowJobId"></a>
|
|
1325
|
+
|
|
1326
|
+
```typescript
|
|
1327
|
+
public readonly buildWorkflowJobId: string;
|
|
1328
|
+
```
|
|
1329
|
+
|
|
1330
|
+
- *Type:* string
|
|
1331
|
+
|
|
1332
|
+
The job ID of the build workflow.
|
|
1333
|
+
|
|
1334
|
+
---
|
|
1335
|
+
|
|
1336
|
+
##### `jest`<sup>Optional</sup> <a name="jest" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.jest"></a>
|
|
1337
|
+
|
|
1338
|
+
```typescript
|
|
1339
|
+
public readonly jest: Jest;
|
|
1340
|
+
```
|
|
1341
|
+
|
|
1342
|
+
- *Type:* projen.javascript.Jest
|
|
1343
|
+
|
|
1344
|
+
The Jest configuration (if enabled).
|
|
1345
|
+
|
|
1346
|
+
---
|
|
1347
|
+
|
|
1348
|
+
##### `maxNodeVersion`<sup>Optional</sup> <a name="maxNodeVersion" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.maxNodeVersion"></a>
|
|
1349
|
+
|
|
1350
|
+
```typescript
|
|
1351
|
+
public readonly maxNodeVersion: string;
|
|
1352
|
+
```
|
|
1353
|
+
|
|
1354
|
+
- *Type:* string
|
|
1355
|
+
|
|
1356
|
+
Maximum node version supported by this package.
|
|
1357
|
+
|
|
1358
|
+
The value indicates the package is incompatible with newer versions.
|
|
1359
|
+
|
|
1360
|
+
---
|
|
1361
|
+
|
|
1362
|
+
##### `minNodeVersion`<sup>Optional</sup> <a name="minNodeVersion" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.minNodeVersion"></a>
|
|
1363
|
+
|
|
1364
|
+
```typescript
|
|
1365
|
+
public readonly minNodeVersion: string;
|
|
1366
|
+
```
|
|
1367
|
+
|
|
1368
|
+
- *Type:* string
|
|
1369
|
+
|
|
1370
|
+
The minimum node version required by this package to function.
|
|
1371
|
+
|
|
1372
|
+
This value indicates the package is incompatible with older versions.
|
|
1373
|
+
|
|
1374
|
+
---
|
|
1375
|
+
|
|
1376
|
+
##### `npmignore`<sup>Optional</sup> <a name="npmignore" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.npmignore"></a>
|
|
1377
|
+
|
|
1378
|
+
```typescript
|
|
1379
|
+
public readonly npmignore: IgnoreFile;
|
|
1380
|
+
```
|
|
1381
|
+
|
|
1382
|
+
- *Type:* projen.IgnoreFile
|
|
1383
|
+
|
|
1384
|
+
The .npmignore file.
|
|
1385
|
+
|
|
1386
|
+
---
|
|
1387
|
+
|
|
1388
|
+
##### `prettier`<sup>Optional</sup> <a name="prettier" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.prettier"></a>
|
|
1389
|
+
|
|
1390
|
+
```typescript
|
|
1391
|
+
public readonly prettier: Prettier;
|
|
1392
|
+
```
|
|
1393
|
+
|
|
1394
|
+
- *Type:* projen.javascript.Prettier
|
|
1395
|
+
|
|
1396
|
+
---
|
|
1397
|
+
|
|
1398
|
+
##### ~~`publisher`~~<sup>Optional</sup> <a name="publisher" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.publisher"></a>
|
|
1399
|
+
|
|
1400
|
+
- *Deprecated:* use `release.publisher`.
|
|
1401
|
+
|
|
1402
|
+
```typescript
|
|
1403
|
+
public readonly publisher: Publisher;
|
|
1404
|
+
```
|
|
1405
|
+
|
|
1406
|
+
- *Type:* projen.release.Publisher
|
|
1407
|
+
|
|
1408
|
+
Package publisher.
|
|
1409
|
+
|
|
1410
|
+
This will be `undefined` if the project does not have a
|
|
1411
|
+
release workflow.
|
|
1412
|
+
|
|
1413
|
+
---
|
|
1414
|
+
|
|
1415
|
+
##### `release`<sup>Optional</sup> <a name="release" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.release"></a>
|
|
1416
|
+
|
|
1417
|
+
```typescript
|
|
1418
|
+
public readonly release: Release;
|
|
1419
|
+
```
|
|
1420
|
+
|
|
1421
|
+
- *Type:* projen.release.Release
|
|
1422
|
+
|
|
1423
|
+
Release management.
|
|
1424
|
+
|
|
1425
|
+
---
|
|
1426
|
+
|
|
1427
|
+
##### `upgradeWorkflow`<sup>Optional</sup> <a name="upgradeWorkflow" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.upgradeWorkflow"></a>
|
|
1428
|
+
|
|
1429
|
+
```typescript
|
|
1430
|
+
public readonly upgradeWorkflow: UpgradeDependencies;
|
|
1431
|
+
```
|
|
1432
|
+
|
|
1433
|
+
- *Type:* projen.javascript.UpgradeDependencies
|
|
1434
|
+
|
|
1435
|
+
The upgrade workflow.
|
|
1436
|
+
|
|
1437
|
+
---
|
|
1438
|
+
|
|
1439
|
+
##### `docsDirectory`<sup>Required</sup> <a name="docsDirectory" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.docsDirectory"></a>
|
|
1440
|
+
|
|
1441
|
+
```typescript
|
|
1442
|
+
public readonly docsDirectory: string;
|
|
1443
|
+
```
|
|
1444
|
+
|
|
1445
|
+
- *Type:* string
|
|
1446
|
+
|
|
1447
|
+
---
|
|
1448
|
+
|
|
1449
|
+
##### `libdir`<sup>Required</sup> <a name="libdir" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.libdir"></a>
|
|
1450
|
+
|
|
1451
|
+
```typescript
|
|
1452
|
+
public readonly libdir: string;
|
|
1453
|
+
```
|
|
1454
|
+
|
|
1455
|
+
- *Type:* string
|
|
1456
|
+
|
|
1457
|
+
The directory in which compiled .js files reside.
|
|
1458
|
+
|
|
1459
|
+
---
|
|
1460
|
+
|
|
1461
|
+
##### `srcdir`<sup>Required</sup> <a name="srcdir" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.srcdir"></a>
|
|
1462
|
+
|
|
1463
|
+
```typescript
|
|
1464
|
+
public readonly srcdir: string;
|
|
1465
|
+
```
|
|
1466
|
+
|
|
1467
|
+
- *Type:* string
|
|
1468
|
+
|
|
1469
|
+
The directory in which the .ts sources reside.
|
|
1470
|
+
|
|
1471
|
+
---
|
|
1472
|
+
|
|
1473
|
+
##### `testdir`<sup>Required</sup> <a name="testdir" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.testdir"></a>
|
|
1474
|
+
|
|
1475
|
+
```typescript
|
|
1476
|
+
public readonly testdir: string;
|
|
1477
|
+
```
|
|
1478
|
+
|
|
1479
|
+
- *Type:* string
|
|
1480
|
+
|
|
1481
|
+
The directory in which tests reside.
|
|
1482
|
+
|
|
1483
|
+
---
|
|
1484
|
+
|
|
1485
|
+
##### `tsconfigDev`<sup>Required</sup> <a name="tsconfigDev" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.tsconfigDev"></a>
|
|
1486
|
+
|
|
1487
|
+
```typescript
|
|
1488
|
+
public readonly tsconfigDev: TypescriptConfig;
|
|
1489
|
+
```
|
|
1490
|
+
|
|
1491
|
+
- *Type:* projen.javascript.TypescriptConfig
|
|
1492
|
+
|
|
1493
|
+
A typescript configuration file which covers all files (sources, tests, projen).
|
|
1494
|
+
|
|
1495
|
+
---
|
|
1496
|
+
|
|
1497
|
+
##### `watchTask`<sup>Required</sup> <a name="watchTask" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.watchTask"></a>
|
|
1498
|
+
|
|
1499
|
+
```typescript
|
|
1500
|
+
public readonly watchTask: Task;
|
|
1501
|
+
```
|
|
1502
|
+
|
|
1503
|
+
- *Type:* projen.Task
|
|
1504
|
+
|
|
1505
|
+
The "watch" task.
|
|
1506
|
+
|
|
1507
|
+
---
|
|
1508
|
+
|
|
1509
|
+
##### `docgen`<sup>Optional</sup> <a name="docgen" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.docgen"></a>
|
|
1510
|
+
|
|
1511
|
+
```typescript
|
|
1512
|
+
public readonly docgen: boolean;
|
|
1513
|
+
```
|
|
1514
|
+
|
|
1515
|
+
- *Type:* boolean
|
|
1516
|
+
|
|
1517
|
+
---
|
|
1518
|
+
|
|
1519
|
+
##### `eslint`<sup>Optional</sup> <a name="eslint" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.eslint"></a>
|
|
1520
|
+
|
|
1521
|
+
```typescript
|
|
1522
|
+
public readonly eslint: Eslint;
|
|
1523
|
+
```
|
|
1524
|
+
|
|
1525
|
+
- *Type:* projen.javascript.Eslint
|
|
1526
|
+
|
|
1527
|
+
---
|
|
1528
|
+
|
|
1529
|
+
##### `tsconfig`<sup>Optional</sup> <a name="tsconfig" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.tsconfig"></a>
|
|
1530
|
+
|
|
1531
|
+
```typescript
|
|
1532
|
+
public readonly tsconfig: TypescriptConfig;
|
|
1533
|
+
```
|
|
1534
|
+
|
|
1535
|
+
- *Type:* projen.javascript.TypescriptConfig
|
|
1536
|
+
|
|
1537
|
+
---
|
|
1538
|
+
|
|
1539
|
+
##### `tsconfigEslint`<sup>Optional</sup> <a name="tsconfigEslint" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.tsconfigEslint"></a>
|
|
1540
|
+
|
|
1541
|
+
```typescript
|
|
1542
|
+
public readonly tsconfigEslint: TypescriptConfig;
|
|
1543
|
+
```
|
|
1544
|
+
|
|
1545
|
+
- *Type:* projen.javascript.TypescriptConfig
|
|
1546
|
+
|
|
1547
|
+
---
|
|
1548
|
+
|
|
1549
|
+
##### `cdkDeps`<sup>Required</sup> <a name="cdkDeps" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.cdkDeps"></a>
|
|
1550
|
+
|
|
1551
|
+
```typescript
|
|
1552
|
+
public readonly cdkDeps: AwsCdkDeps;
|
|
1553
|
+
```
|
|
1554
|
+
|
|
1555
|
+
- *Type:* projen.awscdk.AwsCdkDeps
|
|
1556
|
+
|
|
1557
|
+
---
|
|
1558
|
+
|
|
1559
|
+
##### `cdkVersion`<sup>Required</sup> <a name="cdkVersion" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.cdkVersion"></a>
|
|
1560
|
+
|
|
1561
|
+
```typescript
|
|
1562
|
+
public readonly cdkVersion: string;
|
|
1563
|
+
```
|
|
1564
|
+
|
|
1565
|
+
- *Type:* string
|
|
1566
|
+
|
|
1567
|
+
The target CDK version for this library.
|
|
1568
|
+
|
|
1569
|
+
---
|
|
1570
|
+
|
|
1571
|
+
##### ~~`version`~~<sup>Required</sup> <a name="version" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.version"></a>
|
|
1572
|
+
|
|
1573
|
+
- *Deprecated:* use `cdkVersion`
|
|
1574
|
+
|
|
1575
|
+
```typescript
|
|
1576
|
+
public readonly version: string;
|
|
1577
|
+
```
|
|
1578
|
+
|
|
1579
|
+
- *Type:* string
|
|
1580
|
+
|
|
1581
|
+
---
|
|
1582
|
+
|
|
1583
|
+
##### `workflowNodeVersion`<sup>Required</sup> <a name="workflowNodeVersion" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.workflowNodeVersion"></a>
|
|
1584
|
+
|
|
1585
|
+
```typescript
|
|
1586
|
+
public readonly workflowNodeVersion: string;
|
|
1587
|
+
```
|
|
1588
|
+
|
|
1589
|
+
- *Type:* string
|
|
1590
|
+
|
|
1591
|
+
---
|
|
1592
|
+
|
|
1593
|
+
#### Constants <a name="Constants" id="Constants"></a>
|
|
1594
|
+
|
|
1595
|
+
| **Name** | **Type** | **Description** |
|
|
1596
|
+
| --- | --- | --- |
|
|
1597
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.DEFAULT_TASK">DEFAULT_TASK</a></code> | <code>string</code> | The name of the default task (the task executed when `projen` is run without arguments). |
|
|
1598
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.DEFAULT_TS_JEST_TRANFORM_PATTERN">DEFAULT_TS_JEST_TRANFORM_PATTERN</a></code> | <code>string</code> | *No description.* |
|
|
1599
|
+
|
|
1600
|
+
---
|
|
1601
|
+
|
|
1602
|
+
##### `DEFAULT_TASK`<sup>Required</sup> <a name="DEFAULT_TASK" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.DEFAULT_TASK"></a>
|
|
1603
|
+
|
|
1604
|
+
```typescript
|
|
1605
|
+
public readonly DEFAULT_TASK: string;
|
|
1606
|
+
```
|
|
1607
|
+
|
|
1608
|
+
- *Type:* string
|
|
1609
|
+
|
|
1610
|
+
The name of the default task (the task executed when `projen` is run without arguments).
|
|
1611
|
+
|
|
1612
|
+
Normally
|
|
1613
|
+
this task should synthesize the project files.
|
|
1614
|
+
|
|
1615
|
+
---
|
|
1616
|
+
|
|
1617
|
+
##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`<sup>Required</sup> <a name="DEFAULT_TS_JEST_TRANFORM_PATTERN" id="@alma-cdk/construct-library.AlmaCdkConstructLibrary.property.DEFAULT_TS_JEST_TRANFORM_PATTERN"></a>
|
|
1618
|
+
|
|
1619
|
+
```typescript
|
|
1620
|
+
public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;
|
|
1621
|
+
```
|
|
1622
|
+
|
|
1623
|
+
- *Type:* string
|
|
1624
|
+
|
|
1625
|
+
---
|
|
1626
|
+
|
|
1627
|
+
## Structs <a name="Structs" id="Structs"></a>
|
|
1628
|
+
|
|
1629
|
+
### AlmaCdkConstructLibraryOptions <a name="AlmaCdkConstructLibraryOptions" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions"></a>
|
|
1630
|
+
|
|
1631
|
+
#### Initializer <a name="Initializer" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.Initializer"></a>
|
|
1632
|
+
|
|
1633
|
+
```typescript
|
|
1634
|
+
import { AlmaCdkConstructLibraryOptions } from '@alma-cdk/construct-library'
|
|
1635
|
+
|
|
1636
|
+
const almaCdkConstructLibraryOptions: AlmaCdkConstructLibraryOptions = { ... }
|
|
1637
|
+
```
|
|
1638
|
+
|
|
1639
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1640
|
+
|
|
1641
|
+
| **Name** | **Type** | **Description** |
|
|
1642
|
+
| --- | --- | --- |
|
|
1643
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.author">author</a></code> | <code>string</code> | *No description.* |
|
|
1644
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.authorAddress">authorAddress</a></code> | <code>string</code> | *No description.* |
|
|
1645
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
1646
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | *No description.* |
|
|
1647
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.name">name</a></code> | <code>string</code> | *No description.* |
|
|
1648
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.repositoryUrl">repositoryUrl</a></code> | <code>string</code> | *No description.* |
|
|
1649
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.stability">stability</a></code> | <code>projen.cdk.Stability</code> | *No description.* |
|
|
1650
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | *No description.* |
|
|
1651
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.deps">deps</a></code> | <code>string[]</code> | *No description.* |
|
|
1652
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.devDeps">devDeps</a></code> | <code>string[]</code> | *No description.* |
|
|
1653
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | *No description.* |
|
|
1654
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | *No description.* |
|
|
1655
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | *No description.* |
|
|
1656
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | *No description.* |
|
|
1657
|
+
| <code><a href="#@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | *No description.* |
|
|
1658
|
+
|
|
1659
|
+
---
|
|
1660
|
+
|
|
1661
|
+
##### `author`<sup>Required</sup> <a name="author" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.author"></a>
|
|
1662
|
+
|
|
1663
|
+
```typescript
|
|
1664
|
+
public readonly author: string;
|
|
1665
|
+
```
|
|
1666
|
+
|
|
1667
|
+
- *Type:* string
|
|
1668
|
+
|
|
1669
|
+
---
|
|
1670
|
+
|
|
1671
|
+
##### `authorAddress`<sup>Required</sup> <a name="authorAddress" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.authorAddress"></a>
|
|
1672
|
+
|
|
1673
|
+
```typescript
|
|
1674
|
+
public readonly authorAddress: string;
|
|
1675
|
+
```
|
|
1676
|
+
|
|
1677
|
+
- *Type:* string
|
|
1678
|
+
|
|
1679
|
+
---
|
|
1680
|
+
|
|
1681
|
+
##### `description`<sup>Required</sup> <a name="description" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.description"></a>
|
|
1682
|
+
|
|
1683
|
+
```typescript
|
|
1684
|
+
public readonly description: string;
|
|
1685
|
+
```
|
|
1686
|
+
|
|
1687
|
+
- *Type:* string
|
|
1688
|
+
|
|
1689
|
+
---
|
|
1690
|
+
|
|
1691
|
+
##### `majorVersion`<sup>Required</sup> <a name="majorVersion" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.majorVersion"></a>
|
|
1692
|
+
|
|
1693
|
+
```typescript
|
|
1694
|
+
public readonly majorVersion: number;
|
|
1695
|
+
```
|
|
1696
|
+
|
|
1697
|
+
- *Type:* number
|
|
1698
|
+
|
|
1699
|
+
---
|
|
1700
|
+
|
|
1701
|
+
##### `name`<sup>Required</sup> <a name="name" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.name"></a>
|
|
1702
|
+
|
|
1703
|
+
```typescript
|
|
1704
|
+
public readonly name: string;
|
|
1705
|
+
```
|
|
1706
|
+
|
|
1707
|
+
- *Type:* string
|
|
1708
|
+
|
|
1709
|
+
---
|
|
1710
|
+
|
|
1711
|
+
##### `repositoryUrl`<sup>Required</sup> <a name="repositoryUrl" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.repositoryUrl"></a>
|
|
1712
|
+
|
|
1713
|
+
```typescript
|
|
1714
|
+
public readonly repositoryUrl: string;
|
|
1715
|
+
```
|
|
1716
|
+
|
|
1717
|
+
- *Type:* string
|
|
1718
|
+
|
|
1719
|
+
---
|
|
1720
|
+
|
|
1721
|
+
##### `stability`<sup>Required</sup> <a name="stability" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.stability"></a>
|
|
1722
|
+
|
|
1723
|
+
```typescript
|
|
1724
|
+
public readonly stability: Stability;
|
|
1725
|
+
```
|
|
1726
|
+
|
|
1727
|
+
- *Type:* projen.cdk.Stability
|
|
1728
|
+
|
|
1729
|
+
---
|
|
1730
|
+
|
|
1731
|
+
##### `bundledDeps`<sup>Optional</sup> <a name="bundledDeps" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.bundledDeps"></a>
|
|
1732
|
+
|
|
1733
|
+
```typescript
|
|
1734
|
+
public readonly bundledDeps: string[];
|
|
1735
|
+
```
|
|
1736
|
+
|
|
1737
|
+
- *Type:* string[]
|
|
1738
|
+
|
|
1739
|
+
---
|
|
1740
|
+
|
|
1741
|
+
##### `deps`<sup>Optional</sup> <a name="deps" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.deps"></a>
|
|
1742
|
+
|
|
1743
|
+
```typescript
|
|
1744
|
+
public readonly deps: string[];
|
|
1745
|
+
```
|
|
1746
|
+
|
|
1747
|
+
- *Type:* string[]
|
|
1748
|
+
|
|
1749
|
+
---
|
|
1750
|
+
|
|
1751
|
+
##### `devDeps`<sup>Optional</sup> <a name="devDeps" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.devDeps"></a>
|
|
1752
|
+
|
|
1753
|
+
```typescript
|
|
1754
|
+
public readonly devDeps: string[];
|
|
1755
|
+
```
|
|
1756
|
+
|
|
1757
|
+
- *Type:* string[]
|
|
1758
|
+
|
|
1759
|
+
---
|
|
1760
|
+
|
|
1761
|
+
##### `maxNodeVersion`<sup>Optional</sup> <a name="maxNodeVersion" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.maxNodeVersion"></a>
|
|
1762
|
+
|
|
1763
|
+
```typescript
|
|
1764
|
+
public readonly maxNodeVersion: string;
|
|
1765
|
+
```
|
|
1766
|
+
|
|
1767
|
+
- *Type:* string
|
|
1768
|
+
|
|
1769
|
+
---
|
|
1770
|
+
|
|
1771
|
+
##### `minNodeVersion`<sup>Optional</sup> <a name="minNodeVersion" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.minNodeVersion"></a>
|
|
1772
|
+
|
|
1773
|
+
```typescript
|
|
1774
|
+
public readonly minNodeVersion: string;
|
|
1775
|
+
```
|
|
1776
|
+
|
|
1777
|
+
- *Type:* string
|
|
1778
|
+
|
|
1779
|
+
---
|
|
1780
|
+
|
|
1781
|
+
##### `releaseBranches`<sup>Optional</sup> <a name="releaseBranches" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.releaseBranches"></a>
|
|
1782
|
+
|
|
1783
|
+
```typescript
|
|
1784
|
+
public readonly releaseBranches: {[ key: string ]: BranchOptions};
|
|
1785
|
+
```
|
|
1786
|
+
|
|
1787
|
+
- *Type:* {[ key: string ]: projen.release.BranchOptions}
|
|
1788
|
+
|
|
1789
|
+
---
|
|
1790
|
+
|
|
1791
|
+
##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.releaseEnvironment"></a>
|
|
1792
|
+
|
|
1793
|
+
```typescript
|
|
1794
|
+
public readonly releaseEnvironment: string;
|
|
1795
|
+
```
|
|
1796
|
+
|
|
1797
|
+
- *Type:* string
|
|
1798
|
+
|
|
1799
|
+
---
|
|
1800
|
+
|
|
1801
|
+
##### `workflowNodeVersion`<sup>Optional</sup> <a name="workflowNodeVersion" id="@alma-cdk/construct-library.AlmaCdkConstructLibraryOptions.property.workflowNodeVersion"></a>
|
|
1802
|
+
|
|
1803
|
+
```typescript
|
|
1804
|
+
public readonly workflowNodeVersion: string;
|
|
1805
|
+
```
|
|
1806
|
+
|
|
1807
|
+
- *Type:* string
|
|
1808
|
+
|
|
1809
|
+
---
|
|
1810
|
+
|
|
1811
|
+
|
|
1812
|
+
|