@objectstack/spec 0.1.2 → 0.3.0

package/dist/data/filter.zod.js

@@ -0,0 +1,226 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ALL_OPERATORS = exports.LOGICAL_OPERATORS = exports.FILTER_OPERATORS = exports.NormalizedFilterSchema = exports.QueryFilterSchema = exports.FilterConditionSchema = exports.FieldOperatorsSchema = exports.SpecialOperatorSchema = exports.StringOperatorSchema = exports.RangeOperatorSchema = exports.SetOperatorSchema = exports.ComparisonOperatorSchema = exports.EqualityOperatorSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * Unified Query DSL Specification
+ *
+ * Based on industry best practices from:
+ * - Prisma ORM
+ * - Strapi CMS
+ * - TypeORM
+ * - LoopBack Framework
+ *
+ * Version: 1.0.0
+ * Status: Draft
+ *
+ * Objective: Define a JSON-based, database-agnostic query syntax standard
+ * for data filtering interactions between frontend and backend APIs.
+ *
+ * Design Principles:
+ * 1. Declarative: Frontend describes "what data to get", not "how to query"
+ * 2. Database Agnostic: Syntax contains no database-specific directives
+ * 3. Type Safe: Structure can be statically inferred by TypeScript
+ * 4. Convention over Configuration: Implicit syntax for common queries
+ */
+// ============================================================================
+// 3.1 Comparison Operators
+// ============================================================================
+/**
+ * Comparison operators for equality and inequality checks.
+ * Supported data types: Any
+ */
+exports.EqualityOperatorSchema = zod_1.z.object({
+    /** Equal to (default) - SQL: = | MongoDB: $eq */
+    $eq: zod_1.z.any().optional(),
+    /** Not equal to - SQL: <> or != | MongoDB: $ne */
+    $ne: zod_1.z.any().optional(),
+});
+/**
+ * Comparison operators for numeric and date comparisons.
+ * Supported data types: Number, Date
+ */
+exports.ComparisonOperatorSchema = zod_1.z.object({
+    /** Greater than - SQL: > | MongoDB: $gt */
+    $gt: zod_1.z.union([zod_1.z.number(), zod_1.z.date()]).optional(),
+    /** Greater than or equal to - SQL: >= | MongoDB: $gte */
+    $gte: zod_1.z.union([zod_1.z.number(), zod_1.z.date()]).optional(),
+    /** Less than - SQL: < | MongoDB: $lt */
+    $lt: zod_1.z.union([zod_1.z.number(), zod_1.z.date()]).optional(),
+    /** Less than or equal to - SQL: <= | MongoDB: $lte */
+    $lte: zod_1.z.union([zod_1.z.number(), zod_1.z.date()]).optional(),
+});
+// ============================================================================
+// 3.2 Set & Range Operators
+// ============================================================================
+/**
+ * Set operators for membership checks.
+ */
+exports.SetOperatorSchema = zod_1.z.object({
+    /** In list - SQL: IN (?, ?, ?) | MongoDB: $in */
+    $in: zod_1.z.array(zod_1.z.any()).optional(),
+    /** Not in list - SQL: NOT IN (...) | MongoDB: $nin */
+    $nin: zod_1.z.array(zod_1.z.any()).optional(),
+});
+/**
+ * Range operator for interval checks (closed interval).
+ * SQL: BETWEEN ? AND ? | MongoDB: $gte AND $lte
+ */
+exports.RangeOperatorSchema = zod_1.z.object({
+    /** Between (inclusive) - takes [min, max] array */
+    $between: zod_1.z.tuple([
+        zod_1.z.union([zod_1.z.number(), zod_1.z.date()]),
+        zod_1.z.union([zod_1.z.number(), zod_1.z.date()])
+    ]).optional(),
+});
+// ============================================================================
+// 3.3 String-Specific Operators
+// ============================================================================
+/**
+ * String pattern matching operators.
+ * Note: Case sensitivity should be handled at backend level.
+ */
+exports.StringOperatorSchema = zod_1.z.object({
+    /** Contains substring - SQL: LIKE %?% | MongoDB: $regex */
+    $contains: zod_1.z.string().optional(),
+    /** Starts with prefix - SQL: LIKE ?% | MongoDB: $regex */
+    $startsWith: zod_1.z.string().optional(),
+    /** Ends with suffix - SQL: LIKE %? | MongoDB: $regex */
+    $endsWith: zod_1.z.string().optional(),
+});
+// ============================================================================
+// 3.5 Special Operators
+// ============================================================================
+/**
+ * Special check operators for null and existence.
+ */
+exports.SpecialOperatorSchema = zod_1.z.object({
+    /** Is null check - SQL: IS NULL (true) / IS NOT NULL (false) | MongoDB: field: null */
+    $null: zod_1.z.boolean().optional(),
+    /** Field exists check (primarily for NoSQL) - MongoDB: $exists */
+    $exist: zod_1.z.boolean().optional(),
+});
+// ============================================================================
+// Combined Field Operators
+// ============================================================================
+/**
+ * All field-level operators combined.
+ * These can be applied to individual fields in a filter.
+ */
+exports.FieldOperatorsSchema = zod_1.z.object({
+    // Equality
+    $eq: zod_1.z.any().optional(),
+    $ne: zod_1.z.any().optional(),
+    // Comparison (numeric/date)
+    $gt: zod_1.z.union([zod_1.z.number(), zod_1.z.date()]).optional(),
+    $gte: zod_1.z.union([zod_1.z.number(), zod_1.z.date()]).optional(),
+    $lt: zod_1.z.union([zod_1.z.number(), zod_1.z.date()]).optional(),
+    $lte: zod_1.z.union([zod_1.z.number(), zod_1.z.date()]).optional(),
+    // Set & Range
+    $in: zod_1.z.array(zod_1.z.any()).optional(),
+    $nin: zod_1.z.array(zod_1.z.any()).optional(),
+    $between: zod_1.z.tuple([
+        zod_1.z.union([zod_1.z.number(), zod_1.z.date()]),
+        zod_1.z.union([zod_1.z.number(), zod_1.z.date()])
+    ]).optional(),
+    // String-specific
+    $contains: zod_1.z.string().optional(),
+    $startsWith: zod_1.z.string().optional(),
+    $endsWith: zod_1.z.string().optional(),
+    // Special
+    $null: zod_1.z.boolean().optional(),
+    $exist: zod_1.z.boolean().optional(),
+});
+/**
+ * Zod schema for recursive filter validation.
+ * Uses z.lazy() to handle recursive structure.
+ */
+exports.FilterConditionSchema = zod_1.z.lazy(() => zod_1.z.record(zod_1.z.string(), zod_1.z.any()).and(zod_1.z.object({
+    $and: zod_1.z.array(exports.FilterConditionSchema).optional(),
+    $or: zod_1.z.array(exports.FilterConditionSchema).optional(),
+    $not: exports.FilterConditionSchema.optional(),
+})));
+// ============================================================================
+// Query Filter Wrapper
+// ============================================================================
+/**
+ * Top-level query filter wrapper.
+ * This is typically used as the "where" clause in a query.
+ *
+ * @example
+ * ```typescript
+ * const filter: QueryFilter = {
+ *   where: {
+ *     status: "active",                    // Implicit equality
+ *     age: { $gte: 18 },                   // Explicit operator
+ *     $or: [                               // Logical combination
+ *       { role: "admin" },
+ *       { email: { $contains: "@company.com" } }
+ *     ],
+ *     profile: {                           // Nested relation
+ *       verified: true
+ *     }
+ *   }
+ * }
+ * ```
+ */
+exports.QueryFilterSchema = zod_1.z.object({
+    where: exports.FilterConditionSchema.optional(),
+});
+// ============================================================================
+// Normalization Utilities (Internal Representation)
+// ============================================================================
+/**
+ * Normalized filter AST structure.
+ * This is the internal representation after converting all syntactic sugar
+ * to explicit operators.
+ *
+ * Stage 1: Normalization Pass
+ * Input:  { age: 18, role: "admin" }
+ * Output: { $and: [{ age: { $eq: 18 } }, { role: { $eq: "admin" } }] }
+ *
+ * This simplifies adapter implementation by providing a consistent structure.
+ */
+exports.NormalizedFilterSchema = zod_1.z.lazy(() => zod_1.z.object({
+    $and: zod_1.z.array(zod_1.z.union([
+        // Field condition: { field: { $op: value } }
+        zod_1.z.record(zod_1.z.string(), exports.FieldOperatorsSchema),
+        // Nested logical group
+        exports.NormalizedFilterSchema,
+    ])).optional(),
+    $or: zod_1.z.array(zod_1.z.union([
+        zod_1.z.record(zod_1.z.string(), exports.FieldOperatorsSchema),
+        exports.NormalizedFilterSchema,
+    ])).optional(),
+    $not: zod_1.z.union([
+        zod_1.z.record(zod_1.z.string(), exports.FieldOperatorsSchema),
+        exports.NormalizedFilterSchema,
+    ]).optional(),
+}));
+// ============================================================================
+// Constants & Metadata
+// ============================================================================
+/**
+ * All supported operator keys.
+ * Useful for validation and parsing.
+ */
+exports.FILTER_OPERATORS = [
+    // Equality
+    '$eq', '$ne',
+    // Comparison
+    '$gt', '$gte', '$lt', '$lte',
+    // Set & Range
+    '$in', '$nin', '$between',
+    // String
+    '$contains', '$startsWith', '$endsWith',
+    // Special
+    '$null', '$exist',
+];
+/**
+ * Logical operator keys.
+ */
+exports.LOGICAL_OPERATORS = ['$and', '$or', '$not'];
+/**
+ * All operator keys (field + logical).
+ */
+exports.ALL_OPERATORS = [...exports.FILTER_OPERATORS, ...exports.LOGICAL_OPERATORS];

package/dist/data/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Data Protocol Exports
+ *
+ * Core Business Logic & Data Modeling
+ * - Object, Field, Validation
+ * - Query (AST), Mapping (ETL)
+ * - Permission, Sharing, Flow
+ */
+export * from './field.zod';
+export * from './object.zod';
+export * from './validation.zod';
+export * from './permission.zod';
+export * from './sharing.zod';
+export * from './workflow.zod';
+export * from './flow.zod';
+export * from './dataset.zod';
+export * from './query.zod';
+export * from './filter.zod';
+export * from './mapping.zod';
+export * from './trigger.zod';
+//# sourceMappingURL=index.d.ts.map

package/dist/data/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/data/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC"}

package/dist/data/index.js

@@ -0,0 +1,36 @@
+"use strict";
+/**
+ * Data Protocol Exports
+ *
+ * Core Business Logic & Data Modeling
+ * - Object, Field, Validation
+ * - Query (AST), Mapping (ETL)
+ * - Permission, Sharing, Flow
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./field.zod"), exports);
+__exportStar(require("./object.zod"), exports);
+__exportStar(require("./validation.zod"), exports);
+__exportStar(require("./permission.zod"), exports);
+__exportStar(require("./sharing.zod"), exports);
+__exportStar(require("./workflow.zod"), exports);
+__exportStar(require("./flow.zod"), exports);
+__exportStar(require("./dataset.zod"), exports);
+__exportStar(require("./query.zod"), exports);
+__exportStar(require("./filter.zod"), exports);
+__exportStar(require("./mapping.zod"), exports);
+__exportStar(require("./trigger.zod"), exports);