@infra-blocks/zod-utils 0.1.0-alpha.0

package/README.md

@@ -0,0 +1,30 @@
+# ts-lib-template
+[![Build](https://github.com/infrastructure-blocks/ts-zod-utils/actions/workflows/build.yml/badge.svg)](https://github.com/infrastructure-blocks/ts-zod-utils/actions/workflows/build.yml)
+[![NPM Publish Release From Label](https://github.com/infrastructure-blocks/ts-zod-utils/actions/workflows/npm-publish-release-from-label.yml/badge.svg)](https://github.com/infrastructure-blocks/ts-zod-utils/actions/workflows/npm-publish-release-from-label.yml)
+[![Update From Template](https://github.com/infrastructure-blocks/ts-zod-utils/actions/workflows/update-from-template.yml/badge.svg)](https://github.com/infrastructure-blocks/ts-zod-utils/actions/workflows/update-from-template.yml)
+[![codecov](https://codecov.io/gh/infrastructure-blocks/ts-zod-utils/graph/badge.svg?token=vyI1qM1EZg)](https://codecov.io/gh/infrastructure-blocks/ts-zod-utils)
+
+This package exposes various utilities extending the [zod](https://www.npmjs.com/package/zod) package.
+
+## Development
+
+### Repo init
+
+This repository leverages [nvm](https://github.com/nvm-sh/nvm) and users should have it installed in their local environment.
+In addition, it is recommended that users install a [shell hook](https://github.com/nvm-sh/nvm#deeper-shell-integration)
+so that `nvm use` is run upon changing into a project that utilises `nvm`.
+
+Upon checking out the repository, run the following commands:
+```shell
+nvm install
+npm install
+npm run compile
+npm run lint
+npm run test
+```
+
+### Package publication
+
+Package publication is fully automated at the CI level. This repository leverages the
+[npm-publish-from-label-workflow](https://github.com/infrastructure-blocks/npm-publish-from-label-workflow)
+workflow as a turnkey, automated mechanism for publishing packages. Refer to its documentation for usage information.

package/lib/index.d.ts

@@ -0,0 +1,6 @@
+import { json, jsonFromString } from "./json.js";
+declare const zu: {
+    json: typeof json;
+    jsonFromString: typeof jsonFromString;
+};
+export { zu };

package/lib/index.js

@@ -0,0 +1,7 @@
+import { json, jsonFromString } from "./json.js";
+const zu = {
+    json,
+    jsonFromString,
+};
+export { zu };
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAEjD,MAAM,EAAE,GAAG;IACT,IAAI;IACJ,cAAc;CACf,CAAC;AAEF,OAAO,EAAE,EAAE,EAAE,CAAC"}

package/lib/json.d.ts

@@ -0,0 +1,9 @@
+import { z } from "zod";
+declare const LITERAL_SCHEMA: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>;
+type Literal = z.infer<typeof LITERAL_SCHEMA>;
+type Json = Literal | {
+    [key: string]: Json;
+} | Json[];
+export declare function json(): z.ZodType<Json, z.ZodTypeDef, Json>;
+export declare function jsonFromString(): z.ZodType<Json, z.ZodTypeDef, string>;
+export {};

package/lib/json.js

@@ -0,0 +1,21 @@
+import { z } from "zod";
+const LITERAL_SCHEMA = z.union([z.string(), z.number(), z.boolean(), z.null()]);
+const JSON_SCHEMA = z.lazy(() => z.union([LITERAL_SCHEMA, z.array(JSON_SCHEMA), z.record(JSON_SCHEMA)]));
+export function json() {
+    return JSON_SCHEMA;
+}
+const JSON_FROM_STRING_SCHEMA = z
+    .string()
+    .transform((str, ctx) => {
+    try {
+        return JSON.parse(str);
+    }
+    catch (e) {
+        ctx.addIssue({ code: "custom", message: "Invalid JSON" });
+        return z.NEVER;
+    }
+});
+export function jsonFromString() {
+    return JSON_FROM_STRING_SCHEMA;
+}
+//# sourceMappingURL=json.js.map

package/lib/json.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.js","sourceRoot":"","sources":["../src/json.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;AAIhF,MAAM,WAAW,GAAoB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAC/C,CAAC,CAAC,KAAK,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CACvE,CAAC;AACF,MAAM,UAAU,IAAI;IAClB,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,MAAM,uBAAuB,GAA0C,CAAC;KACrE,MAAM,EAAE;KACR,SAAS,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;IACtB,IAAI;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAS,CAAC;KAChC;IAAC,OAAO,CAAC,EAAE;QACV,GAAG,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC;QAC1D,OAAO,CAAC,CAAC,KAAK,CAAC;KAChB;AACH,CAAC,CAAC,CAAC;AAEL,MAAM,UAAU,cAAc;IAC5B,OAAO,uBAAuB,CAAC;AACjC,CAAC"}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@infra-blocks/zod-utils",
+  "version": "0.1.0-alpha.0",
+  "description": "Extensions to the zod package.",
+  "license": "ISC",
+  "author": "",
+  "type": "module",
+  "exports": "./lib/index.js",
+  "files": [
+    "lib/**/*.{js,d.ts,map}"
+  ],
+  "scripts": {
+    "build": "npm run clean && tsc --project tsconfig.build.json",
+    "clean": "rm -rf lib && rm -f infra-blocks-*.tgz",
+    "compile": "tsc",
+    "lint": "eslint --ext .js,.cjs,.mjs,.json,.ts --max-warnings 0 .",
+    "prepack": "npm run build",
+    "test": "npm run test:unit",
+    "test:coverage": "c8 npm run test",
+    "test:coverage:lcov": "c8 --reporter=lcov npm run test",
+    "test:integration": "mocha --config test/integration/.mocharc.js 'test/integration/**/*.spec.ts'",
+    "test:unit": "mocha --config test/unit/.mocharc.cjs 'test/unit/**/*.spec.ts'"
+  },
+  "dependencies": {
+    "zod": "^3.22.4"
+  },
+  "devDependencies": {
+    "@infra-blocks/test": "^0.1.1",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^20.10.3",
+    "@typescript-eslint/eslint-plugin": "^5.59.8",
+    "@typescript-eslint/parser": "^5.59.8",
+    "c8": "^8.0.0",
+    "eslint": "^8.41.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-json-format": "^2.0.1",
+    "eslint-plugin-prettier": "^4.2.1",
+    "mocha": "^10.2.0",
+    "prettier": "^2.8.8",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.4"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}