industrial-model 0.6.0 → 0.7.0

package/dist/{types-DCP5GMi3.d.cts → types-2jjbs2i7.d.cts}

@@ -157,6 +157,57 @@ 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 RelationReferenceValue<T> = [NonNull<T>] extends [readonly unknown[]] ? NodeId[] : NodeId;
+type NodeIdLike = {
+    space: string;
+    externalId: string;
+};
+type ArrayReferencePropertyKeys<TModel> = {
+    [K in keyof ModelProps<TModel>]: [NonNull<ModelProps<TModel>[K]>] extends [readonly unknown[]] ? [ArrayItem<NonNull<ModelProps<TModel>[K]>>] extends [NodeIdLike] ? K : never : never;
+}[keyof ModelProps<TModel>];
+type ArrayRelationKeys<TModel> = {
+    [K in RelationKeys<TModel>]: [NonNull<ModelRelations<TModel>[K]>] extends [readonly unknown[]] ? K : never;
+}[RelationKeys<TModel>];
+type UpsertProperties<TModel> = Simplify<Partial<ModelProps<TModel>> & {
+    [K in RelationKeys<TModel>]?: RelationReferenceValue<ModelRelations<TModel>[K]>;
+}>;
+type UpsertNode<TModel> = Simplify<NodeId & Partial<Omit<UpsertProperties<TModel>, keyof NodeId>>>;
+interface EdgeCreationContext {
+    startNode: NodeId;
+    endNode: NodeId;
+    edgeType: NodeId;
+}
+type EdgeCreationCallback = (context: EdgeCreationContext) => NodeId;
+type EdgeCreationCallbacks<TProperty extends string = string> = Partial<Record<TProperty, EdgeCreationCallback>>;
+type OnEdgeCreation<TModel> = EdgeCreationCallbacks<Extract<ArrayReferencePropertyKeys<TModel> | ArrayRelationKeys<TModel>, string>>;
+type EdgeMode = "append" | "replace";
+interface UpsertOptions<TModel> {
+    viewExternalId: string;
+    items: UpsertNode<TModel>[];
+    onEdgeCreation?: OnEdgeCreation<TModel>;
+    replace?: boolean;
+    edgeMode?: EdgeMode;
+}
+type UpsertResultItem = {
+    instanceType: "node" | "edge";
+    version?: number;
+    wasModified?: boolean;
+    space: string;
+    externalId: string;
+    createdTime?: number;
+    lastUpdatedTime?: number;
+};
+interface UpsertResult {
+    items: UpsertResultItem[];
+}
+type UpsertExecutor<TModel> = (options: UpsertOptions<TModel>) => Promise<UpsertResult>;
+type DeleteResultItem = Omit<UpsertResultItem, "instanceType"> & {
+    instanceType: "node";
+};
+interface DeleteResult {
+    items: DeleteResultItem[];
+}
+type DeleteExecutor = <TItem extends NodeId>(items: TItem[]) => Promise<DeleteResult>;
 type SearchFilter = {
     query: string;
     operator?: "OR" | "AND";
@@ -213,4 +264,4 @@ type WhereInput<TModel> = {
     [K in keyof ModelProps<TModel> | RelationKeys<TModel>]?: QueryFilterValue<TModel, K>;
 };
 
-export type { AggregateExecutor as A, DataModelId as D, IndustrialModelClientOptions as I, ModelProps as M, NodeId as N, QueryExecutor as Q, AggregateResult as a, AggregateResultItem as b, IndustrialModel as c, ModelRelations as d, QueryResult as e, QueryResultItem as f, QuerySelect as g, AggregateOptions as h, QueryOptions as i };
+export type { AggregateExecutor as A, DataModelId as D, EdgeCreationCallback as E, IndustrialModelClientOptions as I, ModelProps as M, NodeId as N, OnEdgeCreation as O, QueryExecutor as Q, UpsertExecutor as U, DeleteResult as a, AggregateResult as b, AggregateResultItem as c, DeleteExecutor as d, DeleteResultItem as e, EdgeCreationCallbacks as f, EdgeCreationContext as g, EdgeMode as h, IndustrialModel as i, ModelRelations as j, QueryResult as k, QueryResultItem as l, QuerySelect as m, UpsertNode as n, UpsertOptions as o, UpsertProperties as p, UpsertResult as q, UpsertResultItem as r, AggregateOptions as s, QueryOptions as t };

package/dist/{types-DCP5GMi3.d.ts → types-2jjbs2i7.d.ts}

@@ -157,6 +157,57 @@ 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 RelationReferenceValue<T> = [NonNull<T>] extends [readonly unknown[]] ? NodeId[] : NodeId;
+type NodeIdLike = {
+    space: string;
+    externalId: string;
+};
+type ArrayReferencePropertyKeys<TModel> = {
+    [K in keyof ModelProps<TModel>]: [NonNull<ModelProps<TModel>[K]>] extends [readonly unknown[]] ? [ArrayItem<NonNull<ModelProps<TModel>[K]>>] extends [NodeIdLike] ? K : never : never;
+}[keyof ModelProps<TModel>];
+type ArrayRelationKeys<TModel> = {
+    [K in RelationKeys<TModel>]: [NonNull<ModelRelations<TModel>[K]>] extends [readonly unknown[]] ? K : never;
+}[RelationKeys<TModel>];
+type UpsertProperties<TModel> = Simplify<Partial<ModelProps<TModel>> & {
+    [K in RelationKeys<TModel>]?: RelationReferenceValue<ModelRelations<TModel>[K]>;
+}>;
+type UpsertNode<TModel> = Simplify<NodeId & Partial<Omit<UpsertProperties<TModel>, keyof NodeId>>>;
+interface EdgeCreationContext {
+    startNode: NodeId;
+    endNode: NodeId;
+    edgeType: NodeId;
+}
+type EdgeCreationCallback = (context: EdgeCreationContext) => NodeId;
+type EdgeCreationCallbacks<TProperty extends string = string> = Partial<Record<TProperty, EdgeCreationCallback>>;
+type OnEdgeCreation<TModel> = EdgeCreationCallbacks<Extract<ArrayReferencePropertyKeys<TModel> | ArrayRelationKeys<TModel>, string>>;
+type EdgeMode = "append" | "replace";
+interface UpsertOptions<TModel> {
+    viewExternalId: string;
+    items: UpsertNode<TModel>[];
+    onEdgeCreation?: OnEdgeCreation<TModel>;
+    replace?: boolean;
+    edgeMode?: EdgeMode;
+}
+type UpsertResultItem = {
+    instanceType: "node" | "edge";
+    version?: number;
+    wasModified?: boolean;
+    space: string;
+    externalId: string;
+    createdTime?: number;
+    lastUpdatedTime?: number;
+};
+interface UpsertResult {
+    items: UpsertResultItem[];
+}
+type UpsertExecutor<TModel> = (options: UpsertOptions<TModel>) => Promise<UpsertResult>;
+type DeleteResultItem = Omit<UpsertResultItem, "instanceType"> & {
+    instanceType: "node";
+};
+interface DeleteResult {
+    items: DeleteResultItem[];
+}
+type DeleteExecutor = <TItem extends NodeId>(items: TItem[]) => Promise<DeleteResult>;
 type SearchFilter = {
     query: string;
     operator?: "OR" | "AND";
@@ -213,4 +264,4 @@ type WhereInput<TModel> = {
     [K in keyof ModelProps<TModel> | RelationKeys<TModel>]?: QueryFilterValue<TModel, K>;
 };
 
-export type { AggregateExecutor as A, DataModelId as D, IndustrialModelClientOptions as I, ModelProps as M, NodeId as N, QueryExecutor as Q, AggregateResult as a, AggregateResultItem as b, IndustrialModel as c, ModelRelations as d, QueryResult as e, QueryResultItem as f, QuerySelect as g, AggregateOptions as h, QueryOptions as i };
+export type { AggregateExecutor as A, DataModelId as D, EdgeCreationCallback as E, IndustrialModelClientOptions as I, ModelProps as M, NodeId as N, OnEdgeCreation as O, QueryExecutor as Q, UpsertExecutor as U, DeleteResult as a, AggregateResult as b, AggregateResultItem as c, DeleteExecutor as d, DeleteResultItem as e, EdgeCreationCallbacks as f, EdgeCreationContext as g, EdgeMode as h, IndustrialModel as i, ModelRelations as j, QueryResult as k, QueryResultItem as l, QuerySelect as m, UpsertNode as n, UpsertOptions as o, UpsertProperties as p, UpsertResult as q, UpsertResultItem as r, AggregateOptions as s, QueryOptions as t };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "industrial-model",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "TypeScript SDK for querying Cognite Industrial Data Models with a type-safe, graph-aware API",
   "license": "MIT",
   "keywords": [