chore: add nocodb package and update cspell dictionary

.config/.cspell.json

@@ -26,6 +26,7 @@
 		"macchiato",
 		"manypkg",
 		"multipublish",
+		"nocodb",
 		"nodemon",
 		"nvim",
 		"nvmrc",

README.md

@@ -59,6 +59,7 @@ All packages are packaged underneath the `@stephansama` scope (for example: `@st
 | [remark-asciinema](core/remark-asciinema/README.md)                     | ![npm version image](https://img.shields.io/npm/v/%40stephansama%2Fremark-asciinema?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F)           | ![npm downloads](https://img.shields.io/npm/dw/@stephansama/remark-asciinema?labelColor=211F1F)           | A remark plugin that transforms Asciinema links into embedded players or screenshots.         |
 | [svelte-social-share-links](core/svelte-social-share-links/README.md)   | ![npm version image](https://img.shields.io/npm/v/%40stephansama%2Fsvelte-social-share-links?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F)  | ![npm downloads](https://img.shields.io/npm/dw/@stephansama/svelte-social-share-links?labelColor=211F1F)  | Svelte/Web component to share the current url with various social media providers             |
 | [typed-events](core/typed-events/README.md)                             | ![npm version image](https://img.shields.io/npm/v/%40stephansama%2Ftyped-events?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F)               | ![npm downloads](https://img.shields.io/npm/dw/@stephansama/typed-events?labelColor=211F1F)               | Typed events store using standard schema                                                      |
+| [typed-nocodb-api](core/typed-nocodb-api/README.md)                     | ![npm version image](https://img.shields.io/npm/v/%40stephansama%2Ftyped-nocodb-api?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F)           | ![npm downloads](https://img.shields.io/npm/dw/@stephansama/typed-nocodb-api?labelColor=211F1F)           | zod nocodb api                                                                                |
 | [typed-templates](core/typed-templates/README.md)                       | ![npm version image](https://img.shields.io/npm/v/%40stephansama%2Ftyped-templates?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F)            | ![npm downloads](https://img.shields.io/npm/dw/@stephansama/typed-templates?labelColor=211F1F)            | Use standard schema to validate and use handlebar template directories                        |
 
 <!-- WORKSPACE end -->

core/typed-nocodb-api/README.md

@@ -0,0 +1,28 @@
+# @stephansama/typed-nocodb-api
+
+[![Source code](https://img.shields.io/badge/Source-666666?style=flat&logo=github&label=Github&labelColor=211F1F)](https://github.com/stephansama/packages/tree/main/core/typed-nocodb-api)
+[![Documentation](https://img.shields.io/badge/Documentation-211F1F?style=flat&logo=Wikibooks&labelColor=211F1F)](https://packages.stephansama.info/api/@stephansama/typed-nocodb-api)
+[![NPM Version](https://img.shields.io/npm/v/%40stephansama%2Ftyped-nocodb-api?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F)](https://www.npmjs.com/package/@stephansama/typed-nocodb-api)
+[![npm downloads](https://img.shields.io/npm/dw/@stephansama/typed-nocodb-api?labelColor=211F1F)](https://www.npmjs.com/package/@stephansama/typed-nocodb-api)
+
+standard schema compatible nocodb api
+
+##### Table of contents
+
+<details><summary>Open Table of contents</summary>
+
+- [Installation](#installation)
+- [Usage](#usage)
+
+</details>
+
+## Installation
+
+```sh
+pnpm install @stephansama/typed-nocodb-api
+```
+
+## Usage
+
+> \[!CAUTION]
+> WIP

core/typed-nocodb-api/example/index.js

@@ -0,0 +1,27 @@
+// remark-usage-ignore-next
+/* eslint perfectionist/sort-modules: ["off"] */
+// remark-usage-ignore-next
+/* eslint perfectionist/sort-imports: ["off"] */
+// remark-usage-ignore-next
+import * as z from "zod";
+
+import { createApi } from "../dist/index.cjs";
+
+const api = createApi({
+	baseId: process.env.NOCODB_BASE!,
+	origin: "https://nocodb.com",
+	schema: z.object({
+		column1: z.string(),
+		column2: z.enum(["optionOne", "optionTwo", "optionThree"]),
+		column3: z.number(),
+		column4: z.boolean(),
+	}),
+	tableId: process.env.NOCODB_TABLE!,
+	token: process.env.NOCODB_TOKEN,
+});
+
+export function callApi() {
+	api.fetch({
+		action: "LIST",
+	});
+}

core/typed-nocodb-api/package.json

@@ -0,0 +1,49 @@
+{
+	"name": "@stephansama/typed-nocodb-api",
+	"version": "0.0.0",
+	"description": "zod nocodb api",
+	"keywords": [
+		"typed-nocodb-api"
+	],
+	"homepage": "https://packages.stephansama.info/api/@stephansama/typed-nocodb-api",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/stephansama/packages",
+		"directory": "core/typed-nocodb-api"
+	},
+	"license": "MIT",
+	"author": {
+		"name": "Stephan Randle",
+		"email": "stephanrandle.dev@gmail.com",
+		"url": "https://stephansama.info"
+	},
+	"type": "module",
+	"scripts": {
+		"build": "tsdown",
+		"dev": "tsdown --watch",
+		"lint": "eslint ./ --pass-on-no-patterns --no-error-on-unmatched-pattern"
+	},
+	"dependencies": {},
+	"devDependencies": {
+		"tsdown": "catalog:",
+		"zod": "catalog:schema"
+	},
+	"peerDependencies": {
+		"zod": "catalog:schema"
+	},
+	"packageManager": "pnpm@10.11.0",
+	"publishConfig": {
+		"access": "public",
+		"provenance": true
+	},
+	"main": "./dist/index.cjs",
+	"module": "./dist/index.js",
+	"types": "./dist/index.d.cts",
+	"exports": {
+		".": {
+			"import": "./dist/index.js",
+			"require": "./dist/index.cjs"
+		},
+		"./package.json": "./package.json"
+	}
+}

core/typed-nocodb-api/src/index.ts

@@ -0,0 +1,141 @@
+import * as z from "zod";
+
+export const ACTIONS = [
+	"LIST",
+	"CREATE",
+	"UPDATE",
+	"DELETE",
+	"READ",
+	"COUNT",
+] as const;
+export type ACTION = (typeof ACTIONS)[number];
+
+export function createApi<Schema extends z.ZodObject>({
+	baseId,
+	origin,
+	schema,
+	tableId,
+	token,
+}: {
+	baseId: string;
+	origin: string;
+	schema: Schema;
+	tableId: string;
+	token?: string;
+}) {
+	let _token: string | undefined = token;
+
+	const api = {
+		COUNT: {
+			method: "get",
+			responseSchema: z
+				.object({ count: z.number() })
+				.or(z.object({ msg: z.string() })),
+			url: `/api/v3/data/${baseId}/${tableId}/records`,
+		},
+		CREATE: {
+			inputSchema: z.object({ fields: schema }),
+			method: "post",
+			responseSchema: z.object({
+				records: z.array(z.object({ fields: schema, id: z.string() })),
+			}),
+			url: `/api/v3/data/${baseId}/${tableId}/records`,
+		},
+		DELETE: {
+			inputSchema: z.object({ id: z.number() }),
+			method: "patch",
+			responseSchema: z.object(),
+			url: `/api/v3/data/${baseId}/${tableId}/records`,
+		},
+		LIST: {
+			method: "get",
+			querySchema: z.object({
+				fields: z.array(z.string()).or(z.string()),
+				sort: z
+					.object({
+						direction: z.enum(["asc", "desc"]),
+						field: z.string(),
+					})
+					.transform((input) => JSON.stringify(input)),
+			}),
+			responseSchema: z.object({
+				nestedNext: z.string().optional().nullable(),
+				nestedPrev: z.string().optional().nullable(),
+				next: z.string().optional().nullable(),
+				prev: z.string().optional().nullable(),
+				records: z.array(z.object({ fields: schema, id: z.number() })),
+			}),
+			url: `/api/v3/data/${baseId}/${tableId}/records`,
+		},
+		READ: {
+			method: "get",
+			responseSchema: z.object({ fields: schema, id: z.number() }),
+			url: `/api/v3/data/${baseId}/${tableId}/records/{recordId}`,
+		},
+		UPDATE: {
+			inputSchema: z.object({ fields: schema, id: z.string() }),
+			method: "patch",
+			responseSchema: z.object(),
+			url: `/api/v3/data/${baseId}/${tableId}/records`,
+		},
+	} satisfies Record<
+		ACTION,
+		{
+			inputSchema?: z.ZodType;
+			method: "delete" | "get" | "patch" | "post" | "put";
+			querySchema?: z.ZodType;
+			responseSchema: z.ZodType;
+			url: string;
+		}
+	>;
+
+	type API = typeof api;
+
+	return {
+		async fetch(
+			props: {
+				[A in ACTION]: ("inputSchema" extends keyof API[A]
+					? { body: z.infer<API[A]["inputSchema"]> }
+					: {}) &
+					("querySchema" extends keyof API[A]
+						? { query?: z.infer<API[A]["querySchema"]> }
+						: {}) & {
+						action: A;
+						token?: string;
+					};
+			}[ACTION],
+		) {
+			const token = (_token ??= props.token);
+			if (!token) throw new Error("no token provided");
+
+			const current = api[props.action];
+
+			const url = new URL(current.url, origin);
+
+			let params = "";
+
+			if ("query" in props && "querySchema" in current) {
+				const parsed = current.querySchema.parse(props.query);
+				params = "?" + new URLSearchParams(parsed).toString();
+			}
+
+			let body: string | undefined;
+
+			if ("body" in props && "inputSchema" in current) {
+				body = JSON.stringify(current.inputSchema.parse(props.body));
+			}
+
+			const response = await fetch(url + params, {
+				body,
+				headers: new Headers({
+					"accept": "application/json",
+					"xc-token": token,
+				}),
+				method: current.method,
+			});
+
+			const json = await response.json();
+			return current.responseSchema.parse(json);
+		},
+	};
+}

core/typed-nocodb-api/tsconfig.json

@@ -0,0 +1,4 @@
+{
+	"extends": ["../../tsconfig.base.json"],
+	"include": ["./src/**/*"]
+}

core/typed-nocodb-api/tsdown.config.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from "tsdown";
+
+export default defineConfig({
+	attw: true,
+	dts: true,
+	entry: ["src/index.ts"],
+	exports: true,
+	format: ["esm", "cjs"],
+	publint: true,
+	target: "esnext",
+});

core/typed-nocodb-api/typedoc.json

@@ -0,0 +1,12 @@
+{
+	"entryPoints": ["src/*"],
+	"tsconfig": "./tsconfig.json",
+	"exclude": [
+		"**/tests/**",
+		"**/*.test.ts",
+		"**/*.spec.ts",
+		"node_modules",
+		"**/{node_modules,test,book,doc,dist}/**/*",
+		"**/{pages,components}/**"
+	]
+}

eslint.config.ts

@@ -9,7 +9,7 @@ import pluginPnpm from "eslint-plugin-pnpm";
 import eslintPluginReactHooks from "eslint-plugin-react-hooks";
 import storybook from "eslint-plugin-storybook";
 import testingLibrary from "eslint-plugin-testing-library";
-import eslintPluginZodX from "eslint-plugin-zod-x";
+import eslintPluginZodX from "eslint-plugin-zod";
 import { defineConfig } from "eslint/config";
 import globals from "globals";
 import * as jsoncParser from "jsonc-eslint-parser";

package.json

@@ -65,7 +65,7 @@
 		"eslint-plugin-react-hooks": "^7.0.1",
 		"eslint-plugin-storybook": "^10.1.4",
 		"eslint-plugin-testing-library": "^7.13.5",
-		"eslint-plugin-zod-x": "^1.13.2",
+		"eslint-plugin-zod": "^3.0.0",
 		"globals": "^16.5.0",
 		"husky": "^9.1.7",
 		"jsdom": "^27.2.0",