@narrative.io/data-collaboration-sdk-ts 0.0.51 → 0.0.52

package/build/nql/types.js

@@ -1 +1,81 @@
-export {};
+/**
+ *
+ *
+ *
+ * @see {@link https://github.com/colinhacks/zod} for more information about Zod.
+ */
+import { z } from 'zod';
+/**
+ * Defines the structure for a budget object.
+ *
+ * @type {z.ZodObject}
+ */
+export const NqlBudgetObj = z.object({
+    value: z.number().describe('The value of the budget.'),
+    currency: z.enum(['USD']).describe('The currency the budget is described in.'),
+    period: z.enum(['CALENDAR_MONTH']).describe('The period over which the budget will be applied.')
+});
+/**
+ * A schema object used to validate and infer the structure of NqlQuery.
+ *
+ * @constant {z.ZodObject} NqlQueryObj
+ */
+export const NqlQueryInputObj = z.object({
+    nql: z.string().trim().includes('SELECT', {
+        message: 'NQL query must contain a SELECT statement.'
+    })
+        .regex(/^.*\bLIMIT\b.*/is, {
+        message: 'NQL query must contain a LIMIT statement.'
+    })
+        .regex(/^(?!.*\bJOIN\b).*/is, {
+        message: 'NQL query cannot contain a JOIN statement.'
+    })
+        .describe('A NQL query')
+});
+/**
+ * A schema object used to validate and infer the structure of NqlPreSelectExpression.
+ *
+ * @constant {z.ZodEnum} NqlPreSelectExpressionObj
+ */
+export const NqlPreSelectExpressionObj = z.enum(['EXPLAIN']).describe('Expression that occurs before the SELECT statement.').optional();
+export const NqlDatabaseObject = z.enum(['narrative']);
+export const NqlTableObject = z.object({
+    database: NqlDatabaseObject,
+    table: z.enum(['rosetta_stone'])
+});
+export const NqlFieldObj = z.object({
+    field: z.string().trim(),
+    table: NqlTableObject
+});
+export const NqlFilterUnaryExpressionObj = z.object({
+    field: NqlFieldObj,
+    operator: z.enum(['IS NULL', 'IS NOT NULL']).describe('The operator to use for the filter.  As a standalone operator it only expects the field to be defined.')
+});
+const NqlExpression = z.union([NqlFieldObj, z.string(), z.number(), z.boolean()]);
+export const NqlFilterBinaryExpressionObj = z.object({
+    left: NqlExpression,
+    operator: z.enum(['=', '!=', '>', '<', '>=', '<=', 'IN', 'NOT IN', 'LIKE', 'NOT LIKE']).describe('The operator to use for the filter.  As a binary operator it expects both a left and right expression'),
+    right: NqlExpression
+});
+export const NqlFilterExpressionObj = z.union([NqlFilterUnaryExpressionObj, NqlFilterBinaryExpressionObj]);
+export const NqlBooleanExpressionObj = z.enum(['AND', 'OR']).describe('The operator to use for the filter.  As a standalone operator it only expects the field to be defined.');
+export const NqlWhereObj = z.object({
+    booleanExpressions: NqlBooleanExpressionObj.array(),
+    filterExpressions: NqlFilterExpressionObj.array()
+}).refine((clause) => {
+    return clause.booleanExpressions.length === clause.filterExpressions.length - 1;
+}, {
+    message: 'Boolean expression must have one less element than filter expression.'
+});
+export const NqlObj = z.object({
+    explain: NqlPreSelectExpressionObj,
+    select: NqlFieldObj.array(),
+    from: NqlTableObject.array(),
+    where: NqlWhereObj,
+    limit: NqlBudgetObj,
+    sort: z.undefined().describe('Sort is not currently supported in NQL'),
+    group: z.undefined().describe('Group is not currently supported in NQL'),
+    having: z.undefined().describe('Having is not currently supported in NQL'),
+    offset: z.undefined().describe('Offset is not currently supported in NQL'),
+    join: z.undefined().describe('Join is not currently supported in NQL')
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@narrative.io/data-collaboration-sdk-ts",
-  "version": "0.0.51",
+  "version": "0.0.52",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",
@@ -39,7 +39,8 @@
     "typescript": "^5.0.2"
   },
   "dependencies": {
-    "mande": "^2.0.3"
+    "mande": "^2.0.3",
+    "zod": "^3.21.4"
   },
   "files": [
     "build"