@narrative.io/data-collaboration-sdk-ts 0.0.74 → 0.0.75

package/build/nql/DataRulesConverter.d.ts

@@ -1,4 +1,6 @@
-import type { ForecastBody, Nql } from './types';
+import { type ObjectAttribute } from 'src/attributes/types';
+import { type Attribute } from '../attributes';
+import type { DataRulesAttributesField, ForecastBody, Nql } from './types';
 /**
  * Convert an NQL object to a Forecast body.
  * @param {Nql} nqlObject - The NQL object to convert.
@@ -6,3 +8,43 @@ import type { ForecastBody, Nql } from './types';
  * @throws {Error} - Throws an error if price filter conditions are not met.
  */
 export declare function convertNqlObjectToForecastBody(nqlObject: Nql): Promise<ForecastBody>;
+/**
+ * Looks for an attribute with the given name and checks if it is of type 'object'.
+ *
+ * @param {Attribute[]} attributes - An array of attributes to search through.
+ * @param {string} name - The name of the attribute to look for.
+ * @returns {ObjectAttribute | undefined} Returns the attribute if found and is of type 'object', otherwise returns undefined.
+ *
+ * @example
+ * // Assuming attributes is an array of Attribute objects with properties 'name', 'type', and optionally 'properties'.
+ * const attributes = [{ name: 'person', type: 'object', properties: { name: 'John Doe' } }];
+ * // Returns { name: 'person', type: 'object', properties: { name: 'John Doe' } }
+ * isObject(attributes, 'person');
+ */
+export declare function isObject(attributes: Attribute[], name: string): ObjectAttribute | undefined;
+/**
+ * Finds an attribute with the given name, and if it is of type 'object', returns the names of its properties.
+ *
+ * @param {Attribute[]} attributes - An array of attributes to search through.
+ * @param {string} name - The name of the attribute to look for.
+ * @returns {string[]} An array containing the names of the properties if the attribute is of type 'object', otherwise an empty array.
+ *
+ * @example
+ * // Assuming attributes is an array of Attribute objects with properties 'name', 'type', and optionally 'properties'.
+ * const attributes = [{ name: 'person', type: 'object', properties: { name: 'John Doe' } }];
+ * // Returns ['name']
+ * findAttributeProperties(attributes, 'person');
+ */
+export declare function findAttributeProperties(attributes: Attribute[], name: string): string[];
+/**
+ * Builds an array of field objects with names based on the given attribute and properties.
+ *
+ * @param {string} attribute - The primary attribute to be prefixed to each field.
+ * @param {string[]} properties - An array of properties that will be appended to the attribute to form the field names.
+ * @returns {DataRulesAttributesField[]} An array of field objects, where each object has a 'field' property which is a combination of the attribute and property, and an 'exported' property set to true.
+ *
+ * @example
+ * // Returns [{ field: 'person.name', exported: true }, { field: 'person.age', exported: true }]
+ * buildField('person', ['name', 'age']);
+ */
+export declare function buildField(attribute: string, properties: string[]): DataRulesAttributesField[];

package/build/nql/DataRulesConverter.js

@@ -34,13 +34,15 @@ async function getAttributesFromFields(fields) {
     const attributes = await attributesApi.getAttributes();
     const uniqueAttributes = [...new Set(fields.map((field) => field.field.split('.')[0]))].filter((att) => !att.startsWith('_'));
     uniqueAttributes.forEach((att) => {
+        const isObjectProperty = isObject(attributes.records, att);
+        const relevantFields = (isObjectProperty != null) ? fields.filter((field) => field.field.split('.')[0] === att && field.field !== att) : fields.filter((field) => field.field.split('.')[0] === att);
         const attributeId = attributes.records.find((attribute) => attribute.name === att)?.id;
         if (attributeId === undefined) {
             throw new Error(`Attribute ${att} not found`);
         }
         attributesArray.push({
             attribute_id: attributeId,
-            fields: fields.filter((field) => field.field.split('.')[0] === att),
+            fields: relevantFields.length > 0 ? relevantFields : buildField(att, findAttributeProperties(attributes.records, att)),
             optional: fields.some(field => field.field.startsWith(att + '.') && field.filter === undefined)
         });
     });
@@ -212,3 +214,65 @@ function addParentheses(input) {
     // Replace matched string with itself followed by ()
     return input.replace(regex, '$1()');
 }
+/**
+ * Looks for an attribute with the given name and checks if it is of type 'object'.
+ *
+ * @param {Attribute[]} attributes - An array of attributes to search through.
+ * @param {string} name - The name of the attribute to look for.
+ * @returns {ObjectAttribute | undefined} Returns the attribute if found and is of type 'object', otherwise returns undefined.
+ *
+ * @example
+ * // Assuming attributes is an array of Attribute objects with properties 'name', 'type', and optionally 'properties'.
+ * const attributes = [{ name: 'person', type: 'object', properties: { name: 'John Doe' } }];
+ * // Returns { name: 'person', type: 'object', properties: { name: 'John Doe' } }
+ * isObject(attributes, 'person');
+ */
+export function isObject(attributes, name) {
+    // Look for the attribute with the given name.
+    const attribute = attributes.find(attr => attr.name === name);
+    // If no such attribute is found, return an empty array.
+    if (attribute == null) {
+        return undefined;
+    }
+    return attribute.type === 'object' && 'properties' in attribute ? attribute : undefined;
+}
+/**
+ * Finds an attribute with the given name, and if it is of type 'object', returns the names of its properties.
+ *
+ * @param {Attribute[]} attributes - An array of attributes to search through.
+ * @param {string} name - The name of the attribute to look for.
+ * @returns {string[]} An array containing the names of the properties if the attribute is of type 'object', otherwise an empty array.
+ *
+ * @example
+ * // Assuming attributes is an array of Attribute objects with properties 'name', 'type', and optionally 'properties'.
+ * const attributes = [{ name: 'person', type: 'object', properties: { name: 'John Doe' } }];
+ * // Returns ['name']
+ * findAttributeProperties(attributes, 'person');
+ */
+export function findAttributeProperties(attributes, name) {
+    const attribute = isObject(attributes, name);
+    // If the attribute is of type 'object', return the names of its properties.
+    if (attribute != null) {
+        return Object.keys(attribute.properties);
+    }
+    return [];
+}
+/**
+ * Builds an array of field objects with names based on the given attribute and properties.
+ *
+ * @param {string} attribute - The primary attribute to be prefixed to each field.
+ * @param {string[]} properties - An array of properties that will be appended to the attribute to form the field names.
+ * @returns {DataRulesAttributesField[]} An array of field objects, where each object has a 'field' property which is a combination of the attribute and property, and an 'exported' property set to true.
+ *
+ * @example
+ * // Returns [{ field: 'person.name', exported: true }, { field: 'person.age', exported: true }]
+ * buildField('person', ['name', 'age']);
+ */
+export function buildField(attribute, properties) {
+    return properties.map((property) => {
+        return {
+            field: `${attribute}.${property}`,
+            exported: true
+        };
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@narrative.io/data-collaboration-sdk-ts",
-  "version": "0.0.74",
+  "version": "0.0.75",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",