industrial-model 0.4.0 → 0.5.0

package/dist/index.d.cts

@@ -197,10 +197,15 @@ interface AggregateResult<TItem = Record<string, unknown>> {
     items: TItem[];
 }
 type AggregateExecutor<TModel> = <const TOptions extends AggregateOptions<TModel>>(options: TOptions) => Promise<AggregateResult<AggregateResultItem<TModel, TOptions["groupBy"], TOptions["aggregate"]>>>;
+type SearchFilter = {
+    query: string;
+    operator?: "OR" | "AND";
+};
 type StringFilters = {
     eq?: string;
     in?: string[];
     prefix?: string;
+    search?: SearchFilter;
     exists?: boolean;
 };
 type NumberFilters = {
@@ -234,7 +239,9 @@ type ListFilters<T> = {
     containsAny?: T[];
     containsAll?: T[];
     exists?: boolean;
-};
+} & (T extends string ? {
+    search?: SearchFilter;
+} : unknown);
 type BaseFilterFor<T> = T extends NodeId ? NodeIdFilters : T extends string ? StringFilters : T extends number ? NumberFilters : T extends boolean ? BooleanFilters : T extends Date ? DateFilters : T extends Array<infer U> ? ListFilters<U> : T extends object ? NodeIdFilters | WhereInput<T> : never;
 type RelationFilterFor<T> = UnwrapRelationTarget<T> extends object ? WhereInput<UnwrapRelationTarget<T>> : never;
 type QueryFilterValue<TModel, K extends PropertyKey> = K extends RelationKeys<TModel> ? K extends keyof ModelProps<TModel> ? BaseFilterFor<ModelProps<TModel>[K]> | RelationFilterFor<ModelRelations<TModel>[K]> : RelationFilterFor<ModelRelations<TModel>[K]> : K extends keyof ModelProps<TModel> ? BaseFilterFor<ModelProps<TModel>[K]> : never;

package/dist/index.d.ts

@@ -197,10 +197,15 @@ interface AggregateResult<TItem = Record<string, unknown>> {
     items: TItem[];
 }
 type AggregateExecutor<TModel> = <const TOptions extends AggregateOptions<TModel>>(options: TOptions) => Promise<AggregateResult<AggregateResultItem<TModel, TOptions["groupBy"], TOptions["aggregate"]>>>;
+type SearchFilter = {
+    query: string;
+    operator?: "OR" | "AND";
+};
 type StringFilters = {
     eq?: string;
     in?: string[];
     prefix?: string;
+    search?: SearchFilter;
     exists?: boolean;
 };
 type NumberFilters = {
@@ -234,7 +239,9 @@ type ListFilters<T> = {
     containsAny?: T[];
     containsAll?: T[];
     exists?: boolean;
-};
+} & (T extends string ? {
+    search?: SearchFilter;
+} : unknown);
 type BaseFilterFor<T> = T extends NodeId ? NodeIdFilters : T extends string ? StringFilters : T extends number ? NumberFilters : T extends boolean ? BooleanFilters : T extends Date ? DateFilters : T extends Array<infer U> ? ListFilters<U> : T extends object ? NodeIdFilters | WhereInput<T> : never;
 type RelationFilterFor<T> = UnwrapRelationTarget<T> extends object ? WhereInput<UnwrapRelationTarget<T>> : never;
 type QueryFilterValue<TModel, K extends PropertyKey> = K extends RelationKeys<TModel> ? K extends keyof ModelProps<TModel> ? BaseFilterFor<ModelProps<TModel>[K]> | RelationFilterFor<ModelRelations<TModel>[K]> : RelationFilterFor<ModelRelations<TModel>[K]> : K extends keyof ModelProps<TModel> ? BaseFilterFor<ModelProps<TModel>[K]> : never;

package/dist/index.js

@@ -26,6 +26,13 @@ var CogniteSdkAdapter = class {
       nextCursor: response.nextCursor
     };
   }
+  async searchInstances(request) {
+    const search = this.client.instances.search;
+    const response = await search(request);
+    return {
+      items: response.items
+    };
+  }
   async aggregateInstances(request) {
     const response = await this.client.instances.aggregate(
       request
@@ -184,6 +191,7 @@ var leafOps = /* @__PURE__ */ new Set([
   "lte",
   "exists",
   "prefix",
+  "search",
   "containsAny",
   "containsAll"
 ]);
@@ -236,19 +244,33 @@ function leafFilterSchema(property) {
   const value = baseValueSchema(property);
   const isList = typeof property !== "string" && property.type.list === true;
   if (isList) {
-    return z.object({
+    const shape = {
       containsAny: z.array(value).optional(),
       containsAll: z.array(value).optional(),
       exists: z.boolean().optional()
-    }).strict();
+    };
+    if (property.type.type === "text") {
+      shape.search = z.object({
+        query: z.string(),
+        operator: z.enum(["OR", "AND"]).optional()
+      }).strict().optional();
+    }
+    return z.object(shape).strict();
   }
   if (property === "node-string" || typeof property !== "string" && property.type.type === "text") {
-    return z.object({
+    const shape = {
       eq: z.string().optional(),
       in: z.array(z.string()).optional(),
       prefix: z.string().optional(),
       exists: z.boolean().optional()
-    }).strict();
+    };
+    if (property !== "node-string") {
+      shape.search = z.object({
+        query: z.string(),
+        operator: z.enum(["OR", "AND"]).optional()
+      }).strict().optional();
+    }
+    return z.object(shape).strict();
   }
   if (typeof property !== "string" && property.type.type === "enum") {
     return z.object({
@@ -608,11 +630,13 @@ function isLeafFilter2(value) {
   return Object.keys(value).some((k) => LEAF_OPS.has(k));
 }
 var FilterMapper = class {
-  constructor(viewMapper) {
+  constructor(viewMapper, cognite) {
     this.viewMapper = viewMapper;
+    this.cognite = cognite;
   }
   async map(input, rootView) {
     const result = [];
+    const searchQueries = {};
     for (const [key, value] of Object.entries(input)) {
       if (value == null) continue;
       if (key === "AND") {
@@ -633,17 +657,44 @@ var FilterMapper = class {
       } else {
         const filterValue = value;
         const property = getPropertyRef(key, rootView);
-        if (isLeafFilter2(filterValue)) {
+        const hasLeafFilter = isLeafFilter2(filterValue);
+        if (hasLeafFilter) {
           result.push(...this.leafToFilterDefs(property, filterValue));
-        } else {
+        }
+        if ("search" in filterValue && filterValue.search != null) {
+          searchQueries[key] = filterValue.search;
+        } else if (!hasLeafFilter) {
           const targetView = await this.getNestedTargetView(key, rootView);
           const innerFilter = await this.whereInputToSingle(filterValue, targetView);
           result.push({ nested: { scope: property, filter: innerFilter } });
         }
       }
     }
+    if (Object.keys(searchQueries).length > 0) {
+      const searchFilters = await Promise.all(
+        Object.entries(searchQueries).map(
+          ([key, filterValue]) => this.searchToFilterDef(key, filterValue, rootView)
+        )
+      );
+      result.push(...searchFilters);
+    }
     return result;
   }
+  async searchToFilterDef(propertyName, search, rootView) {
+    const response = await this.cognite.searchInstances({
+      view: toViewReference(rootView),
+      query: search.query,
+      instanceType: "node",
+      properties: [propertyName],
+      operator: search.operator ?? "OR",
+      limit: 1e3
+    });
+    const instanceRefs = response.items.map((item) => ({
+      space: item.space,
+      externalId: item.externalId
+    }));
+    return { instanceReferences: instanceRefs };
+  }
   async whereInputToSingle(input, rootView) {
     const filters = await this.map(input, rootView);
     const [firstFilter, ...restFilters] = filters;
@@ -722,9 +773,9 @@ var FilterMapper = class {
 
 // src/mappers/aggregate-mapper.ts
 var AggregateMapper = class {
-  constructor(viewMapper) {
+  constructor(viewMapper, cognite) {
     this.viewMapper = viewMapper;
-    this.filterMapper = new FilterMapper(viewMapper);
+    this.filterMapper = new FilterMapper(viewMapper, cognite);
     this.validator = new AggregateValidator(viewMapper);
   }
   async map(options) {
@@ -819,9 +870,9 @@ var SortMapper = class {
 
 // src/mappers/query-mapper.ts
 var QueryMapper = class {
-  constructor(viewMapper) {
+  constructor(viewMapper, cognite) {
     this.viewMapper = viewMapper;
-    this.filterMapper = new FilterMapper(viewMapper);
+    this.filterMapper = new FilterMapper(viewMapper, cognite);
     this.sortMapper = new SortMapper();
     this.validator = new QueryValidator(viewMapper);
   }
@@ -1367,8 +1418,8 @@ var IndustrialModelClient = class {
     const cognite = createCogniteAdapter(client);
     this.cognite = cognite;
     const viewMapper = new ViewMapper(cognite, dataModelId);
-    this.queryMapper = new QueryMapper(viewMapper);
-    this.aggregateMapper = new AggregateMapper(viewMapper);
+    this.queryMapper = new QueryMapper(viewMapper, cognite);
+    this.aggregateMapper = new AggregateMapper(viewMapper, cognite);
     this.aggregateResultMapper = new AggregateResultMapper();
     this.resultMapper = new QueryResultMapper(viewMapper);
     this.resultValidator = new QueryResultValidator(viewMapper);