@openapi-typescript-infra/service 4.2.0 → 4.3.0

package/.trunk/trunk.yaml

@@ -1,22 +1,22 @@
 version: 0.1
 cli:
-  version: 1.16.2
+  version: 1.17.1
 plugins:
   sources:
     - id: trunk
-      ref: v1.2.5
+      ref: v1.2.6
       uri: https://github.com/trunk-io/plugins
 lint:
   enabled:
     - actionlint@1.6.26
-    - checkov@2.5.7
+    - checkov@2.5.9
     - eslint@8.51.0
     - git-diff-check
     - markdownlint@0.37.0
     - osv-scanner@1.4.1
     - prettier@3.0.3
-    - trivy@0.45.1
-    - trufflehog@3.59.0
+    - trivy@0.46.0
+    - trufflehog@3.60.0
     - yamllint@1.32.0
   ignore:
     - linters: [ALL]

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [4.3.0](https://github.com/openapi-typescript-infra/service/compare/v4.2.0...v4.3.0) (2023-10-19)
+
+
+### Bug Fixes
+
+* **yarn:** update lockfile ([24b492b](https://github.com/openapi-typescript-infra/service/commit/24b492b4c8780a361b8187ce6e002c94d862fb27))
+
+
+### Features
+
+* **config:** add support for generating config schema validation ([a5c9c3f](https://github.com/openapi-typescript-infra/service/commit/a5c9c3f65bfc2798a97a4ffe960ffd88df9f9115))
+
 # [4.2.0](https://github.com/openapi-typescript-infra/service/compare/v4.1.1...v4.2.0) (2023-10-18)
 
 

package/Makefile

@@ -51,6 +51,26 @@ src/generated/service/index.ts: $(shell find api -type f)
 	./node_modules/.bin/prettier ./src/generated/service/index.ts --write
 	rm -rf $(TMP)
 
+
+# Config schema generation
+# Function to convert snake case to camel case
+define to_camel
+$(shell echo $(1) | awk -F- '{for(i=1; i<=NF; i++) $i=toupper(substr($i,1,1)) substr($i,2)} 1' | tr -d '\n')
+endef
+
+export CONFIG_SOURCE ?= src/types/config.ts
+export CONFIG_TYPE ?= $(call to_camel,$(SERVICE_NAME))ConfigSchema
+
+config-schema: src/generated/config-schema.ts
+
+src/generated/config-schema.ts: $(CONFIG_SOURCE)
+	mkdir -p src/generated
+	echo "Building config schema"
+	node ./build/bin/generate-config-schema.js \
+		--source $(CONFIG_SOURCE) \
+		--type $(CONFIG_TYPE) \
+		--output src/generated/config-schema.ts
+
 # Postgres database things
 export PGUSER ?= postgres
 export PGPASSWORD ?= postgres

package/build/bin/generate-config-schema.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/build/bin/generate-config-schema.js

@@ -0,0 +1,53 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const child_process_1 = require("child_process");
+const ajv_1 = __importDefault(require("ajv"));
+const standalone_1 = __importDefault(require("ajv/dist/standalone"));
+const minimist_1 = __importDefault(require("minimist"));
+// Generate an AJV validator from a Typescript type
+// This is mostly included since we already have AJV,
+// and we want you to use it to validate configurations.
+const argv = (0, minimist_1.default)(process.argv.slice(2));
+async function run() {
+    // First we need to run typescript-json-schema to
+    // generate the JSON schema. We use npx to avoid the
+    // runtime dependency.
+    const tsJsonSchema = (0, child_process_1.spawnSync)('npx', [
+        '-y',
+        'typescript-json-schema',
+        argv.tsconfig || 'tsconfig.build.json',
+        argv.type,
+        '--required',
+        '--noExtraProps',
+        '--strictNullChecks',
+        '--include',
+        argv.source || 'src/types/config.ts',
+    ], {
+        stdio: 'pipe',
+        encoding: 'utf-8',
+    });
+    if (tsJsonSchema.status !== 0) {
+        console.error(tsJsonSchema.stderr);
+        process.exit(1);
+    }
+    const schema = JSON.parse(tsJsonSchema.stdout);
+    const ajv = new ajv_1.default({ code: { source: true, esm: true } });
+    const validate = ajv.compile(schema);
+    const moduleCode = (0, standalone_1.default)(ajv, validate);
+    if (argv.output) {
+        fs_1.default.writeFileSync(argv.output, `// @ts-nocheck\n${moduleCode}\n`);
+    }
+    else {
+        console.log(moduleCode);
+    }
+}
+run().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+//# sourceMappingURL=generate-config-schema.js.map

package/build/bin/generate-config-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-config-schema.js","sourceRoot":"","sources":["../../src/bin/generate-config-schema.ts"],"names":[],"mappings":";;;;;;AACA,4CAAoB;AACpB,iDAA0C;AAE1C,8CAAsB;AACtB,qEAAiD;AACjD,wDAAgC;AAEhC,mDAAmD;AACnD,qDAAqD;AACrD,wDAAwD;AACxD,MAAM,IAAI,GAAG,IAAA,kBAAQ,EAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAE7C,KAAK,UAAU,GAAG;IAChB,iDAAiD;IACjD,oDAAoD;IACpD,sBAAsB;IACtB,MAAM,YAAY,GAAG,IAAA,yBAAS,EAC5B,KAAK,EACL;QACE,IAAI;QACJ,wBAAwB;QACxB,IAAI,CAAC,QAAQ,IAAI,qBAAqB;QACtC,IAAI,CAAC,IAAI;QACT,YAAY;QACZ,gBAAgB;QAChB,oBAAoB;QACpB,WAAW;QACX,IAAI,CAAC,MAAM,IAAI,qBAAqB;KACrC,EACD;QACE,KAAK,EAAE,MAAM;QACb,QAAQ,EAAE,OAAO;KAClB,CACF,CAAC;IACF,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;QAC7B,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QACnC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAE/C,MAAM,GAAG,GAAG,IAAI,aAAG,CAAC,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;IAC3D,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,UAAU,GAAG,IAAA,oBAAc,EAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IACjD,IAAI,IAAI,CAAC,MAAM,EAAE;QACf,YAAE,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,mBAAmB,UAAU,IAAI,CAAC,CAAC;KAClE;SAAM;QACL,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;KACzB;AACH,CAAC;AAED,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;IAClB,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}