rads-db 3.0.28 → 3.0.29

package/dist/index.d.ts

@@ -312,9 +312,12 @@ interface RestFileUploadDriverOptions {
      * Otherwise, "application/json" body (with base64-encoded binary content) will be used */
     useFormData?: boolean;
 }
-type GenerateClientOptions = Partial<GenerateClientNormalizedOptions>;
+type GenerateClientOptions = GenerateClientNormalizedOptions;
 interface GenerateClientNormalizedOptions {
-    entitiesDir: string;
+    /** For servers - path to your entities directory, e.g. "./entities" */
+    entitiesDir?: string;
+    /** For client-only integrations - base url of your API, e.g. "https://my-website/api" */
+    apiUrl?: string;
 }
 interface RadsVitePluginOptions extends GenerateClientOptions {
     /** To simplify debugging, makes modules available on window.

package/integrations/cli.cjs

@@ -1,7 +1,20 @@
 // #!/usr/bin/env node
 "use strict";
 
+var _nodeUtil = require("node:util");
 var _node = require("./node.cjs");
-(0, _node.generateClient)({
-  entitiesDir: "./test/entities"
-});
+const args = (0, _nodeUtil.parseArgs)({
+  options: {
+    entitiesDir: {
+      type: "string",
+      short: "d"
+    },
+    apiUrl: {
+      type: "string",
+      short: "u"
+    }
+  },
+  allowPositionals: false,
+  strict: true
+});
+(0, _node.generateClient)(args.values);

package/integrations/cli.mjs

@@ -1,3 +1,18 @@
 #!/usr/bin/env node
+import { parseArgs } from "node:util";
 import { generateClient } from "./node.mjs";
-generateClient({ entitiesDir: "./test/entities" });
+const args = parseArgs({
+  options: {
+    entitiesDir: {
+      type: "string",
+      short: "d"
+    },
+    apiUrl: {
+      type: "string",
+      short: "u"
+    }
+  },
+  allowPositionals: false,
+  strict: true
+});
+generateClient(args.values);

package/integrations/node.cjs

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.generateClient = generateClient;
 exports.getIndexDts = getIndexDts;
+exports.getSchema = getSchema;
 var _promises = _interopRequireDefault(require("node:fs/promises"));
 var _nodeFs = _interopRequireDefault(require("node:fs"));
 var _nodePath = _interopRequireDefault(require("node:path"));
@@ -12,26 +13,9 @@ var _lodash = _interopRequireDefault(require("lodash"));
 var _lib = require("./lib.cjs");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 async function generateClient(options) {
-  const normalizedOptions = {
-    entitiesDir: "./entities",
-    ...options
-  };
-  const {
-    entitiesDir
-  } = normalizedOptions;
+  const normalizedOptions = normalizeOptions(options);
   console.time("[rads-db] Schema generated in");
-  if (!_nodeFs.default.existsSync(entitiesDir)) await _promises.default.mkdir(entitiesDir);
-  const response = await _promises.default.readdir(entitiesDir, {
-    withFileTypes: true
-  });
-  const entities = {};
-  for (const file of response) {
-    if (!file.isFile()) continue;
-    if (!file.name.endsWith(".ts")) continue;
-    const text = await _promises.default.readFile(_nodePath.default.resolve(entitiesDir, file.name), "utf-8");
-    entities[file.name.slice(0, -3)] = text;
-  }
-  const schema = (0, _lib.parseSchema)(entities);
+  const schema = await getSchema(normalizedOptions);
   const nodeModulesPath = _nodePath.default.resolve("./node_modules");
   const radsDbPath = _nodePath.default.join(nodeModulesPath, "./_rads-db");
   if (!_nodeFs.default.existsSync(nodeModulesPath)) {
@@ -59,6 +43,53 @@ export const schema = ${JSON.stringify(schema)}
   }, null, 2));
   console.timeEnd("[rads-db] Schema generated in");
 }
+async function getSchema(normalizedOptions) {
+  const {
+    entitiesDir,
+    apiUrl
+  } = normalizedOptions;
+  let schema;
+  if (entitiesDir) {
+    if (!_nodeFs.default.existsSync(entitiesDir)) await _promises.default.mkdir(entitiesDir);
+    const response = await _promises.default.readdir(entitiesDir, {
+      withFileTypes: true
+    });
+    const entities = {};
+    for (const file of response) {
+      if (!file.isFile()) continue;
+      if (!file.name.endsWith(".ts")) continue;
+      const text = await _promises.default.readFile(_nodePath.default.resolve(entitiesDir, file.name), "utf-8");
+      entities[file.name.slice(0, -3)] = text;
+    }
+    schema = (0, _lib.parseSchema)(entities);
+  } else if (apiUrl) {
+    const fetchResponse = await fetch(_nodePath.default.join(apiUrl, "radsTunnel"), {
+      method: "POST",
+      headers: {
+        "content-type": "application/json"
+      },
+      body: JSON.stringify({
+        method: "_schema"
+      })
+    });
+    schema = await fetchResponse.json();
+    if (!schema) {
+      throw new Error("Could not download schema from the server. Please check the server URL.");
+    }
+  } else {
+    throw new Error("Please specify entitiesDir or apiUrl");
+  }
+  return schema;
+}
+function normalizeOptions(options) {
+  options = options || {};
+  if (options.entitiesDir && options.apiUrl) throw new Error('You cannot specify both "apiUrl" and "entitiesDir". Choose one.');
+  if (options.apiUrl) return options;
+  return {
+    entitiesDir: "./entities",
+    ...options
+  };
+}
 function getIndexDts(schema, options) {
   const imports = [];
   const rootFields = [];
@@ -66,7 +97,7 @@ function getIndexDts(schema, options) {
   const entityMeta = [];
   for (const key in schema) {
     const type = schema[key];
-    if (!type.decorators.entity) continue;
+    if (!type.fields) continue;
     imports.push(`import type { ${type.name} } from '../../${options.entitiesDir}/${key}'`);
     rootFields.push(`${type.handle}: EntityMethods<${type.name}, '${type.name}', ${type.name}_Where>`);
     const fieldsArray = Object.values(type.fields);

package/integrations/node.d.ts

@@ -1,3 +1,4 @@
 import type { GenerateClientNormalizedOptions, GenerateClientOptions, Schema } from '@/types';
 export declare function generateClient(options?: GenerateClientOptions): Promise<void>;
+export declare function getSchema(normalizedOptions: GenerateClientNormalizedOptions): Promise<any>;
 export declare function getIndexDts(schema: Schema, options: GenerateClientNormalizedOptions): string;

package/integrations/node.mjs

@@ -4,22 +4,9 @@ import path from "node:path";
 import _ from "lodash";
 import { parseSchema } from "./lib.mjs";
 export async function generateClient(options) {
-  const normalizedOptions = { entitiesDir: "./entities", ...options };
-  const { entitiesDir } = normalizedOptions;
+  const normalizedOptions = normalizeOptions(options);
   console.time("[rads-db] Schema generated in");
-  if (!fs2.existsSync(entitiesDir))
-    await fs.mkdir(entitiesDir);
-  const response = await fs.readdir(entitiesDir, { withFileTypes: true });
-  const entities = {};
-  for (const file of response) {
-    if (!file.isFile())
-      continue;
-    if (!file.name.endsWith(".ts"))
-      continue;
-    const text = await fs.readFile(path.resolve(entitiesDir, file.name), "utf-8");
-    entities[file.name.slice(0, -3)] = text;
-  }
-  const schema = parseSchema(entities);
+  const schema = await getSchema(normalizedOptions);
   const nodeModulesPath = path.resolve("./node_modules");
   const radsDbPath = path.join(nodeModulesPath, "./_rads-db");
   if (!fs2.existsSync(nodeModulesPath)) {
@@ -56,6 +43,46 @@ export const schema = ${JSON.stringify(schema)}
   );
   console.timeEnd("[rads-db] Schema generated in");
 }
+export async function getSchema(normalizedOptions) {
+  const { entitiesDir, apiUrl } = normalizedOptions;
+  let schema;
+  if (entitiesDir) {
+    if (!fs2.existsSync(entitiesDir))
+      await fs.mkdir(entitiesDir);
+    const response = await fs.readdir(entitiesDir, { withFileTypes: true });
+    const entities = {};
+    for (const file of response) {
+      if (!file.isFile())
+        continue;
+      if (!file.name.endsWith(".ts"))
+        continue;
+      const text = await fs.readFile(path.resolve(entitiesDir, file.name), "utf-8");
+      entities[file.name.slice(0, -3)] = text;
+    }
+    schema = parseSchema(entities);
+  } else if (apiUrl) {
+    const fetchResponse = await fetch(path.join(apiUrl, "radsTunnel"), {
+      method: "POST",
+      headers: { "content-type": "application/json" },
+      body: JSON.stringify({ method: "_schema" })
+    });
+    schema = await fetchResponse.json();
+    if (!schema) {
+      throw new Error("Could not download schema from the server. Please check the server URL.");
+    }
+  } else {
+    throw new Error("Please specify entitiesDir or apiUrl");
+  }
+  return schema;
+}
+function normalizeOptions(options) {
+  options = options || {};
+  if (options.entitiesDir && options.apiUrl)
+    throw new Error('You cannot specify both "apiUrl" and "entitiesDir". Choose one.');
+  if (options.apiUrl)
+    return options;
+  return { entitiesDir: "./entities", ...options };
+}
 export function getIndexDts(schema, options) {
   const imports = [];
   const rootFields = [];
@@ -63,7 +90,7 @@ export function getIndexDts(schema, options) {
   const entityMeta = [];
   for (const key in schema) {
     const type = schema[key];
-    if (!type.decorators.entity)
+    if (!type.fields)
       continue;
     imports.push(`import type { ${type.name} } from '../../${options.entitiesDir}/${key}'`);
     rootFields.push(`${type.handle}: EntityMethods<${type.name}, '${type.name}', ${type.name}_Where>`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rads-db",
-  "version": "3.0.28",
+  "version": "3.0.29",
   "files": [
     "dist",
     "drivers",