@quadrokit/client 0.2.6 → 0.2.8

package/README.md

@@ -14,12 +14,12 @@ After install, the binary name is **`quadrokit-client`** (not the scoped package
 
 ```bash
 bunx quadrokit-client generate \
-  --url 'http://localhost:7080/rest/$catalog' \
+  --url 'http://localhost:7080/rest/$catalog/$all' \
   --token YOUR_TOKEN \
   --out .quadrokit/generated
 ```
 
-- **`--url`**: HTTP(S) catalog URL or `file:///absolute/path/to/catalog.json`
+- **`--url`**: HTTP(S) catalog URL or `file:///absolute/path/to/catalog.json`. Use **`/rest/$catalog/$all`** so the JSON includes dataclass **attributes**; plain `/rest/$catalog` only lists names (empty types). Defaults to `${VITE_4D_ORIGIN}/rest/$catalog/$all`.
 - **`--token`**: optional `Authorization: Bearer …` for protected catalog endpoints
 - **`--out`**: output directory (default `.quadrokit/generated`)
 

package/dist/cli.mjs

@@ -2,7 +2,7 @@
 import { readFile } from 'node:fs/promises';
 import { fileURLToPath } from 'node:url';
 import { catalogFetchInit, defaultLoginUrlFromCatalogUrl, fetch4DAdminSessionCookie, vLog, wrapFetchError, } from './generate/catalog-session.mjs';
-import { writeGenerated } from './generate/codegen.mjs';
+import { warnIfCatalogLacksAttributes, writeGenerated } from './generate/codegen.mjs';
 import { applyGenerateDotenv } from './generate/dotenv-cwd.mjs';
 function parseArgs(argv) {
     let command = '';
@@ -42,6 +42,14 @@ function parseArgs(argv) {
     }
     return { command, url, token, accessKey, loginUrl, out, verbose, insecureTls };
 }
+/** 4D sometimes returns `dataClass` (summary) vs `dataClasses` (detail); align to `dataClasses`. */
+function normalizeCatalogJson(raw) {
+    const o = raw;
+    if (o && typeof o === 'object' && !o.dataClasses && Array.isArray(o.dataClass)) {
+        return { ...o, dataClasses: o.dataClass };
+    }
+    return raw;
+}
 function envFlag(name) {
     const v = process.env[name]?.trim().toLowerCase();
     return v === '1' || v === 'true' || v === 'yes';
@@ -60,7 +68,7 @@ async function loadCatalog(url, auth, debug) {
         vLog(debug, '📂', 'Local file', p);
         const text = await readFile(p, 'utf8');
         vLog(debug, '✅', 'Catalog JSON', `Read ${text.length} bytes from disk`);
-        return JSON.parse(text);
+        return normalizeCatalogJson(JSON.parse(text));
     }
     const headers = {
         Accept: 'application/json',
@@ -109,7 +117,7 @@ async function main() {
     if (command !== 'generate') {
         console.error(`Usage: quadrokit-client generate [--url <catalog_url>] [auth] [options] [--out <dir>]
 
-  --url defaults to \${VITE_4D_ORIGIN}/rest/\\$catalog (from env or .env in cwd), else http://127.0.0.1:7080/rest/\\$catalog
+  --url defaults to \${VITE_4D_ORIGIN}/rest/\\$catalog/\\$all (from env or .env in cwd), else http://127.0.0.1:7080/rest/\\$catalog/\\$all
 
 Auth (generator only; not used by the app runtime):
   --access-key <key>   POST multipart accessKey to /api/login, then use 4DAdminSID for the catalog
@@ -125,8 +133,8 @@ Env / .env: VITE_4D_ORIGIN, QUADROKIT_ACCESS_KEY, QUADROKIT_LOGIN_URL, QUADROKIT
 
 Examples:
   quadrokit-client generate -v
-  quadrokit-client generate --url https://localhost:7443/rest/\\$catalog --access-key MY_TOKEN --insecure-tls -v
-  quadrokit-client generate --url http://localhost:7080/rest/\\$catalog --token secret
+  quadrokit-client generate --url https://localhost:7443/rest/\\$catalog/\\$all --access-key MY_TOKEN --insecure-tls -v
+  quadrokit-client generate --url http://localhost:7080/rest/\\$catalog/\\$all --token secret
   quadrokit-client generate --url file://./assets/catalog.json --out .quadrokit/generated
 
   bunx -p @quadrokit/client quadrokit-client generate
@@ -138,7 +146,7 @@ Examples:
     let url = parsed.url;
     if (!url) {
         const origin = (process.env.VITE_4D_ORIGIN || 'http://127.0.0.1:7080').replace(/\/$/, '');
-        url = `${origin}/rest/$catalog`;
+        url = `${origin}/rest/$catalog/$all`;
     }
     const accessKey = accessKeyArg?.trim() || process.env.QUADROKIT_ACCESS_KEY?.trim() || undefined;
     const loginUrl = loginUrlArg?.trim() || process.env.QUADROKIT_LOGIN_URL?.trim() || undefined;
@@ -148,6 +156,7 @@ Examples:
         loginUrl,
         token: accessKey ? undefined : bearer,
     }, debug);
+    warnIfCatalogLacksAttributes(catalog);
     await writeGenerated(out, catalog);
     if (debug.verbose) {
         vLog(debug, '🎉', 'All set', `Generated client → ${out}`);

package/dist/generate/codegen.d.ts

@@ -1,3 +1,5 @@
 import type { CatalogJson } from '@quadrokit/shared';
+/** Warn when the catalog lists dataclasses but omits attributes (e.g. plain `GET /rest/$catalog` instead of `/rest/$catalog/$all`). */
+export declare function warnIfCatalogLacksAttributes(catalog: CatalogJson): void;
 export declare function writeGenerated(outDir: string, catalog: CatalogJson): Promise<void>;
 //# sourceMappingURL=codegen.d.ts.map

package/dist/generate/codegen.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"codegen.d.ts","sourceRoot":"","sources":["../../src/generate/codegen.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAsC,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAgTxF,wBAAsB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAiBxF"}
+{"version":3,"file":"codegen.d.ts","sourceRoot":"","sources":["../../src/generate/codegen.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAsC,WAAW,EAAE,MAAM,mBAAmB,CAAA;AA8TxF,uIAAuI;AACvI,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI,CAYvE;AAED,wBAAsB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAiBxF"}

package/dist/generate/codegen.mjs

@@ -104,8 +104,12 @@ function emitInterface(dc, _byName) {
     lines.push('}');
     return lines.join('\n');
 }
+/** Include dataclasses unless explicitly not exposed (`exposed === false`). Omitted `exposed` is treated as true. */
+function exposedDataClasses(catalog) {
+    return catalog.dataClasses?.filter((d) => d.exposed !== false) ?? [];
+}
 function emitTypes(catalog) {
-    const classes = catalog.dataClasses?.filter((d) => d.exposed) ?? [];
+    const classes = exposedDataClasses(catalog);
     const byName = new Map(classes.map((c) => [c.name, c]));
     const interfaces = classes.map((c) => emitInterface(c, byName));
     const pathTypes = classes.map((c) => {
@@ -114,10 +118,18 @@ function emitTypes(catalog) {
         const body = paths.length ? paths.map((p) => `'${p}'`).join('\n  | ') : 'never';
         return `export type ${name} =\n  | ${body};`;
     });
-    return `/* eslint-disable */\n/* Auto-generated by @quadrokit/client — do not edit */\n\n${interfaces.join('\n\n')}\n\n${pathTypes.join('\n\n')}\n`;
+    const header = `/* eslint-disable */\n/* Auto-generated by @quadrokit/client — do not edit */\n`;
+    if (classes.length === 0) {
+        const raw = catalog.dataClasses?.length ?? 0;
+        const note = raw > 0
+            ? `\n/**\n * No entity types: all ${raw} data class(es) in the catalog have exposed: false.\n * Enable REST exposure for tables in 4D, then run quadrokit-client generate again.\n */\n`
+            : `\n/**\n * No entity types: the catalog has no dataClasses (or an empty list).\n */\n`;
+        return `${header}${note}\n`;
+    }
+    return `${header}\n${interfaces.join('\n\n')}\n\n${pathTypes.join('\n\n')}\n`;
 }
 function emitClient(catalog) {
-    const classes = catalog.dataClasses?.filter((d) => d.exposed) ?? [];
+    const classes = exposedDataClasses(catalog);
     const dbName = catalog.__NAME ?? 'default';
     const hasAuthentify = catalog.methods?.some((m) => m.name === 'authentify' && m.applyTo === 'dataStore');
     const keyNamesRecord = Object.fromEntries(classes.map((x) => [x.name, keyNames(x)]));
@@ -275,6 +287,18 @@ export type QuadroClient = ReturnType<typeof createClient>;
 `;
     return header + metaExport + configInterface + body;
 }
+/** Warn when the catalog lists dataclasses but omits attributes (e.g. plain `GET /rest/$catalog` instead of `/rest/$catalog/$all`). */
+export function warnIfCatalogLacksAttributes(catalog) {
+    const classes = exposedDataClasses(catalog);
+    if (classes.length === 0) {
+        return;
+    }
+    const allLackAttrs = classes.every((c) => !(c.attributes && c.attributes.length > 0));
+    if (!allLackAttrs) {
+        return;
+    }
+    console.error('quadrokit: catalog has dataclass names but no attribute details. Fetch the full catalog: GET /rest/$catalog/$all (plain /rest/$catalog omits attributes). See 4D REST docs: $catalog/$all.');
+}
 export async function writeGenerated(outDir, catalog) {
     await mkdir(outDir, { recursive: true });
     await writeFile(path.join(outDir, 'types.gen.ts'), emitTypes(catalog), 'utf8');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quadrokit/client",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "description": "Typed 4D REST client and catalog code generator for QuadroKit",
   "type": "module",
   "main": "./dist/index.mjs",
@@ -29,7 +29,7 @@
     "generate:fixture": "bun run src/cli.ts generate --url file://../../assets/catalog.json --out ../../.quadrokit/generated-demo"
   },
   "dependencies": {
-    "@quadrokit/shared": "^0.2.6",
+    "@quadrokit/shared": "^0.2.8",
     "undici": "^6.21.0"
   },
   "peerDependencies": {