@objectstack/spec 0.3.2 → 0.4.1

package/dist/system/datasource.zod.js

@@ -1,19 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DatasourceSchema = exports.DatasourceCapabilities = exports.DriverDefinitionSchema = exports.DriverType = exports.BuiltInDrivers = void 0;
+exports.DatasourceSchema = exports.DatasourceCapabilities = exports.DriverDefinitionSchema = exports.DriverType = void 0;
 const zod_1 = require("zod");
-/**
- * Driver Type Enum (Built-in)
- * Standard drivers supported by the core platform.
- * Plugins can register additional drivers using different identifiers.
- */
-exports.BuiltInDrivers = [
-    'postgres', 'mysql', 'sqlserver', 'oracle', 'sqlite', // SQL
-    'mongo', 'redis', // NoSQL
-    'excel', 'csv', 'airtable', // Spreadsheet / Low-code
-    'rest_api', 'graphql', 'odata', // Web Services
-    'salesforce', 'sap', 'workday' // Enterprise SaaS
-];
 /**
  * Driver Identifier
  * Can be a built-in driver or a plugin-contributed driver (e.g., "com.vendor.snowflake").
@@ -97,6 +85,22 @@ exports.DatasourceSchema = zod_1.z.object({
      * Stored securely (passwords usually interpolated from ENV).
      */
     config: zod_1.z.record(zod_1.z.any()).describe('Driver specific configuration'),
+    /**
+     * Connection Pool Configuration
+     * Standard connection pooling settings.
+     */
+    pool: zod_1.z.object({
+        min: zod_1.z.number().default(0).describe('Minimum connections'),
+        max: zod_1.z.number().default(10).describe('Maximum connections'),
+        idleTimeoutMillis: zod_1.z.number().default(30000).describe('Idle timeout'),
+        connectionTimeoutMillis: zod_1.z.number().default(3000).describe('Connection establishment timeout'),
+    }).optional().describe('Connection pool settings'),
+    /**
+     * Read Replicas
+     * Optional list of duplicate configurations for read-only operations.
+     * Useful for scaling read throughput.
+     */
+    readReplicas: zod_1.z.array(zod_1.z.record(zod_1.z.any())).optional().describe('Read-only replica configurations'),
     /**
      * Capability Overrides
      * Manually override what the driver claims to support.

package/dist/system/driver/mongo.zod.d.ts

@@ -0,0 +1,107 @@
+import { z } from 'zod';
+/**
+ * MongoDB Driver Configuration Schema
+ * Defines the connection settings specific to MongoDB.
+ */
+export declare const MongoConfigSchema: z.ZodObject<{
+    /**
+     * Connection URI.
+     * If provided, it takes precedence over host/port/database.
+     * Format: mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]
+     */
+    url: z.ZodOptional<z.ZodString>;
+    /**
+     * Database Name.
+     * Required to identify which database to use within the cluster.
+     */
+    database: z.ZodString;
+    /**
+     * Hostname or IP address.
+     * Defaults to localhost if not specified.
+     */
+    host: z.ZodDefault<z.ZodString>;
+    /**
+     * Port number.
+     * Defaults to 27017.
+     */
+    port: z.ZodDefault<z.ZodNumber>;
+    /**
+     * Authentication Username.
+     */
+    username: z.ZodOptional<z.ZodString>;
+    /**
+     * Authentication Password.
+     */
+    password: z.ZodOptional<z.ZodString>;
+    /**
+     * Authentication Database.
+     * The database where the user credentials are stored (defaults to 'admin' or the target database).
+     */
+    authSource: z.ZodOptional<z.ZodString>;
+    /**
+     * Enable SSL/TLS.
+     */
+    ssl: z.ZodDefault<z.ZodBoolean>;
+    /**
+     * Replica Set Name.
+     * Required if connecting to a replica set.
+     */
+    replicaSet: z.ZodOptional<z.ZodString>;
+    /**
+     * Read Preference.
+     * Controls which members of the replica set usually receive read operations.
+     */
+    readPreference: z.ZodDefault<z.ZodEnum<["primary", "primaryPreferred", "secondary", "secondaryPreferred", "nearest"]>>;
+    /**
+     * Connection Pool Size.
+     * The maximum number of connections in the connection pool.
+     */
+    maxPoolSize: z.ZodOptional<z.ZodNumber>;
+    /**
+     * Min Connection Pool Size.
+     * The minimum number of connections in the connection pool.
+     */
+    minPoolSize: z.ZodOptional<z.ZodNumber>;
+    /**
+     * Connect Timeout (ms).
+     * How long to wait for a connection to be established before timing out.
+     */
+    connectTimeoutMS: z.ZodOptional<z.ZodNumber>;
+    /**
+     * Socket Timeout (ms).
+     * How long a socket can remain idle before being closed.
+     */
+    socketTimeoutMS: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    database: string;
+    host: string;
+    port: number;
+    ssl: boolean;
+    readPreference: "primary" | "secondary" | "primaryPreferred" | "secondaryPreferred" | "nearest";
+    url?: string | undefined;
+    password?: string | undefined;
+    username?: string | undefined;
+    authSource?: string | undefined;
+    replicaSet?: string | undefined;
+    maxPoolSize?: number | undefined;
+    minPoolSize?: number | undefined;
+    connectTimeoutMS?: number | undefined;
+    socketTimeoutMS?: number | undefined;
+}, {
+    database: string;
+    url?: string | undefined;
+    password?: string | undefined;
+    host?: string | undefined;
+    port?: number | undefined;
+    username?: string | undefined;
+    authSource?: string | undefined;
+    ssl?: boolean | undefined;
+    replicaSet?: string | undefined;
+    readPreference?: "primary" | "secondary" | "primaryPreferred" | "secondaryPreferred" | "nearest" | undefined;
+    maxPoolSize?: number | undefined;
+    minPoolSize?: number | undefined;
+    connectTimeoutMS?: number | undefined;
+    socketTimeoutMS?: number | undefined;
+}>;
+export type MongoConfig = z.infer<typeof MongoConfigSchema>;
+//# sourceMappingURL=mongo.zod.d.ts.map

package/dist/system/driver/mongo.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mongo.zod.d.ts","sourceRoot":"","sources":["../../../src/system/driver/mongo.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,eAAO,MAAM,iBAAiB;IAC5B;;;;OAIG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAKH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEH,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC"}

package/dist/system/driver/mongo.zod.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MongoConfigSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * MongoDB Driver Configuration Schema
+ * Defines the connection settings specific to MongoDB.
+ */
+exports.MongoConfigSchema = zod_1.z.object({
+    /**
+     * Connection URI.
+     * If provided, it takes precedence over host/port/database.
+     * Format: mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]
+     */
+    url: zod_1.z.string().optional().describe('Connection URI'),
+    /**
+     * Database Name.
+     * Required to identify which database to use within the cluster.
+     */
+    database: zod_1.z.string().describe('Database Name'),
+    /**
+     * Hostname or IP address.
+     * Defaults to localhost if not specified.
+     */
+    host: zod_1.z.string().default('127.0.0.1').describe('Host address'),
+    /**
+     * Port number.
+     * Defaults to 27017.
+     */
+    port: zod_1.z.number().default(27017).describe('Port number'),
+    /**
+     * Authentication Username.
+     */
+    username: zod_1.z.string().optional().describe('Auth User'),
+    /**
+     * Authentication Password.
+     */
+    password: zod_1.z.string().optional().describe('Auth Password'),
+    /**
+     * Authentication Database.
+     * The database where the user credentials are stored (defaults to 'admin' or the target database).
+     */
+    authSource: zod_1.z.string().optional().describe('Authentication Database'),
+    /**
+     * Enable SSL/TLS.
+     */
+    ssl: zod_1.z.boolean().default(false).describe('Enable SSL'),
+    /**
+     * Replica Set Name.
+     * Required if connecting to a replica set.
+     */
+    replicaSet: zod_1.z.string().optional().describe('Replica Set Name'),
+    /**
+     * Read Preference.
+     * Controls which members of the replica set usually receive read operations.
+     */
+    readPreference: zod_1.z.enum(['primary', 'primaryPreferred', 'secondary', 'secondaryPreferred', 'nearest'])
+        .default('primary')
+        .describe('Read Preference'),
+    /**
+     * Connection Pool Size.
+     * The maximum number of connections in the connection pool.
+     */
+    maxPoolSize: zod_1.z.number().optional().describe('Max Connection Pool Size'),
+    /**
+     * Min Connection Pool Size.
+     * The minimum number of connections in the connection pool.
+     */
+    minPoolSize: zod_1.z.number().optional().describe('Min Connection Pool Size'),
+    /**
+     * Connect Timeout (ms).
+     * How long to wait for a connection to be established before timing out.
+     */
+    connectTimeoutMS: zod_1.z.number().optional().describe('Connection Timeout (ms)'),
+    /**
+     * Socket Timeout (ms).
+     * How long a socket can remain idle before being closed.
+     */
+    socketTimeoutMS: zod_1.z.number().optional().describe('Socket Timeout (ms)'),
+});

package/dist/system/driver/postgres.zod.d.ts

@@ -0,0 +1,134 @@
+import { z } from 'zod';
+/**
+ * PostgreSQL Driver Configuration Schema
+ * Defines the connection settings specific to PostgreSQL.
+ */
+export declare const PostgresConfigSchema: z.ZodObject<{
+    /**
+     * Connection URI.
+     * If provided, it takes precedence over host/port/database.
+     * Format: postgresql://[user[:password]@][netloc][:port][/dbname][?param1=value1&...]
+     */
+    url: z.ZodOptional<z.ZodString>;
+    /**
+     * Database Name.
+     */
+    database: z.ZodString;
+    /**
+     * Hostname or IP address.
+     * Defaults to localhost.
+     */
+    host: z.ZodDefault<z.ZodString>;
+    /**
+     * Port number.
+     * Defaults to 5432.
+     */
+    port: z.ZodDefault<z.ZodNumber>;
+    /**
+     * Authentication Username.
+     */
+    username: z.ZodOptional<z.ZodString>;
+    /**
+     * Authentication Password.
+     */
+    password: z.ZodOptional<z.ZodString>;
+    /**
+     * Default Schema.
+     * The schema to use for tables that do not specify a schema.
+     * Defaults to 'public'.
+     */
+    schema: z.ZodDefault<z.ZodString>;
+    /**
+     * Enable SSL/TLS.
+     * Can be a boolean or an object with specific SSL configuration (ca, cert, key, rejectUnauthorized).
+     */
+    ssl: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodObject<{
+        rejectUnauthorized: z.ZodOptional<z.ZodBoolean>;
+        ca: z.ZodOptional<z.ZodString>;
+        key: z.ZodOptional<z.ZodString>;
+        cert: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        key?: string | undefined;
+        rejectUnauthorized?: boolean | undefined;
+        ca?: string | undefined;
+        cert?: string | undefined;
+    }, {
+        key?: string | undefined;
+        rejectUnauthorized?: boolean | undefined;
+        ca?: string | undefined;
+        cert?: string | undefined;
+    }>]>>;
+    /**
+     * Application Name.
+     * Sets the application_name configuration parameter.
+     */
+    applicationName: z.ZodOptional<z.ZodString>;
+    /**
+     * Connection Pool: Max Clients.
+     * Maximum number of clients the pool should contain.
+     */
+    max: z.ZodDefault<z.ZodNumber>;
+    /**
+     * Connection Pool: Min Clients.
+     * Minimum number of clients to keep in the pool.
+     */
+    min: z.ZodDefault<z.ZodNumber>;
+    /**
+     * Idle Timeout (ms).
+     * The number of milliseconds a client must sit idle in the pool and not be checked out
+     * before it is disconnected from the backend and discarded.
+     */
+    idleTimeoutMillis: z.ZodOptional<z.ZodNumber>;
+    /**
+     * Connection Timeout (ms).
+     * The number of milliseconds to wait before timing out when connecting a new client.
+     */
+    connectionTimeoutMillis: z.ZodOptional<z.ZodNumber>;
+    /**
+    * Statement Timeout (ms).
+    * Abort any statement that takes more than the specified number of milliseconds.
+    */
+    statementTimeout: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    min: number;
+    max: number;
+    database: string;
+    schema: string;
+    host: string;
+    port: number;
+    url?: string | undefined;
+    password?: string | undefined;
+    idleTimeoutMillis?: number | undefined;
+    connectionTimeoutMillis?: number | undefined;
+    username?: string | undefined;
+    ssl?: boolean | {
+        key?: string | undefined;
+        rejectUnauthorized?: boolean | undefined;
+        ca?: string | undefined;
+        cert?: string | undefined;
+    } | undefined;
+    applicationName?: string | undefined;
+    statementTimeout?: number | undefined;
+}, {
+    database: string;
+    min?: number | undefined;
+    max?: number | undefined;
+    url?: string | undefined;
+    password?: string | undefined;
+    schema?: string | undefined;
+    idleTimeoutMillis?: number | undefined;
+    connectionTimeoutMillis?: number | undefined;
+    host?: string | undefined;
+    port?: number | undefined;
+    username?: string | undefined;
+    ssl?: boolean | {
+        key?: string | undefined;
+        rejectUnauthorized?: boolean | undefined;
+        ca?: string | undefined;
+        cert?: string | undefined;
+    } | undefined;
+    applicationName?: string | undefined;
+    statementTimeout?: number | undefined;
+}>;
+export type PostgresConfig = z.infer<typeof PostgresConfigSchema>;
+//# sourceMappingURL=postgres.zod.d.ts.map

package/dist/system/driver/postgres.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"postgres.zod.d.ts","sourceRoot":"","sources":["../../../src/system/driver/postgres.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,eAAO,MAAM,oBAAoB;IAC/B;;;;OAIG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;OAIG;;IAGH;;;OAGG;;;;;;;;;;;;;;;;;IAWH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;OAIG;;IAGH;;;OAGG;;IAGF;;;MAGE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEH,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC"}

package/dist/system/driver/postgres.zod.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostgresConfigSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * PostgreSQL Driver Configuration Schema
+ * Defines the connection settings specific to PostgreSQL.
+ */
+exports.PostgresConfigSchema = zod_1.z.object({
+    /**
+     * Connection URI.
+     * If provided, it takes precedence over host/port/database.
+     * Format: postgresql://[user[:password]@][netloc][:port][/dbname][?param1=value1&...]
+     */
+    url: zod_1.z.string().optional().describe('Connection URI'),
+    /**
+     * Database Name.
+     */
+    database: zod_1.z.string().describe('Database Name'),
+    /**
+     * Hostname or IP address.
+     * Defaults to localhost.
+     */
+    host: zod_1.z.string().default('localhost').describe('Host address'),
+    /**
+     * Port number.
+     * Defaults to 5432.
+     */
+    port: zod_1.z.number().default(5432).describe('Port number'),
+    /**
+     * Authentication Username.
+     */
+    username: zod_1.z.string().optional().describe('Auth User'),
+    /**
+     * Authentication Password.
+     */
+    password: zod_1.z.string().optional().describe('Auth Password'),
+    /**
+     * Default Schema.
+     * The schema to use for tables that do not specify a schema.
+     * Defaults to 'public'.
+     */
+    schema: zod_1.z.string().default('public').describe('Default Schema'),
+    /**
+     * Enable SSL/TLS.
+     * Can be a boolean or an object with specific SSL configuration (ca, cert, key, rejectUnauthorized).
+     */
+    ssl: zod_1.z.union([
+        zod_1.z.boolean(),
+        zod_1.z.object({
+            rejectUnauthorized: zod_1.z.boolean().optional(),
+            ca: zod_1.z.string().optional(),
+            key: zod_1.z.string().optional(),
+            cert: zod_1.z.string().optional(),
+        })
+    ]).optional().describe('Enable SSL'),
+    /**
+     * Application Name.
+     * Sets the application_name configuration parameter.
+     */
+    applicationName: zod_1.z.string().optional().describe('Application Name'),
+    /**
+     * Connection Pool: Max Clients.
+     * Maximum number of clients the pool should contain.
+     */
+    max: zod_1.z.number().default(10).describe('Max Pool Size'),
+    /**
+     * Connection Pool: Min Clients.
+     * Minimum number of clients to keep in the pool.
+     */
+    min: zod_1.z.number().default(0).describe('Min Pool Size'),
+    /**
+     * Idle Timeout (ms).
+     * The number of milliseconds a client must sit idle in the pool and not be checked out
+     * before it is disconnected from the backend and discarded.
+     */
+    idleTimeoutMillis: zod_1.z.number().optional().describe('Idle Timeout (ms)'),
+    /**
+     * Connection Timeout (ms).
+     * The number of milliseconds to wait before timing out when connecting a new client.
+     */
+    connectionTimeoutMillis: zod_1.z.number().optional().describe('Connection Timeout (ms)'),
+    /**
+    * Statement Timeout (ms).
+    * Abort any statement that takes more than the specified number of milliseconds.
+    */
+    statementTimeout: zod_1.z.number().optional().describe('Statement Timeout (ms)'),
+});