industrial-model 0.5.0 → 0.7.0

package/dist/cognite-core/index.d.cts

@@ -0,0 +1,535 @@
+import { CogniteClient } from '@cognite/sdk';
+import { i as IndustrialModel, N as NodeId, s as AggregateOptions, b as AggregateResult, c as AggregateResultItem, m as QuerySelect, t as QueryOptions, k as QueryResult, l as QueryResultItem, o as UpsertOptions, q as UpsertResult, I as IndustrialModelClientOptions, a as DeleteResult } from '../types-2jjbs2i7.cjs';
+
+type CogniteCoreViewExternalId = "CogniteDescribable" | "CogniteSourceable" | "CogniteSourceSystem" | "CogniteSchedulable" | "CogniteVisualizable" | "Cognite3DTransformation" | "CogniteCubeMap" | "Cognite3DObject" | "Cognite3DModel" | "CogniteCADModel" | "Cognite3DRevision" | "CognitePointCloudModel" | "Cognite360ImageModel" | "CogniteCADRevision" | "CognitePointCloudRevision" | "Cognite360ImageCollection" | "CogniteCADNode" | "CognitePointCloudVolume" | "Cognite360Image" | "Cognite360ImageStation" | "Cognite360ImageAnnotation" | "CogniteAsset" | "CogniteAssetClass" | "CogniteAssetType" | "CogniteEquipment" | "CogniteEquipmentType" | "CogniteFile" | "CogniteFileCategory" | "CogniteActivity" | "CogniteTimeSeries" | "CogniteAnnotation" | "CogniteDiagramAnnotation" | "CogniteUnit";
+type CogniteDescribable = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+}>;
+type CogniteSourceable = IndustrialModel<{
+    sourceId?: string;
+    sourceContext?: string;
+    source?: NodeId;
+    sourceCreatedTime?: string;
+    sourceUpdatedTime?: string;
+    sourceCreatedUser?: string;
+    sourceUpdatedUser?: string;
+}, {
+    source?: CogniteSourceSystem;
+}>;
+type CogniteSourceSystem = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    version?: string;
+    manufacturer?: string;
+}>;
+type CogniteSchedulable = IndustrialModel<{
+    startTime?: string;
+    endTime?: string;
+    scheduledStartTime?: string;
+    scheduledEndTime?: string;
+}>;
+type CogniteVisualizable = IndustrialModel<{
+    object3D?: NodeId;
+}, {
+    object3D?: Cognite3DObject;
+}>;
+type Cognite3DTransformation = IndustrialModel<{
+    translationX?: number;
+    translationY?: number;
+    translationZ?: number;
+    eulerRotationX?: number;
+    eulerRotationY?: number;
+    eulerRotationZ?: number;
+    scaleX?: number;
+    scaleY?: number;
+    scaleZ?: number;
+}>;
+type CogniteCubeMap = IndustrialModel<{
+    front?: NodeId;
+    back?: NodeId;
+    left?: NodeId;
+    right?: NodeId;
+    top?: NodeId;
+    bottom?: NodeId;
+}, {
+    front?: CogniteFile;
+    back?: CogniteFile;
+    left?: CogniteFile;
+    right?: CogniteFile;
+    top?: CogniteFile;
+    bottom?: CogniteFile;
+}>;
+type Cognite3DObject = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    xMin?: number;
+    xMax?: number;
+    yMin?: number;
+    yMax?: number;
+    zMin?: number;
+    zMax?: number;
+}, {
+    asset?: CogniteAsset;
+    cadNodes?: CogniteCADNode[];
+    images360?: Cognite360Image[];
+    pointCloudVolumes?: CognitePointCloudVolume[];
+}>;
+type Cognite3DModel = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    thumbnail?: NodeId;
+    type?: string;
+}, {
+    thumbnail?: CogniteFile;
+}>;
+type CogniteCADModel = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    thumbnail?: NodeId;
+    type?: string;
+}, {
+    thumbnail?: CogniteFile;
+    revisions?: CogniteCADRevision[];
+}>;
+type Cognite3DRevision = IndustrialModel<{
+    status?: string;
+    published?: boolean;
+    type?: string;
+    model3D?: NodeId;
+}, {
+    model3D?: Cognite3DModel;
+}>;
+type CognitePointCloudModel = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    thumbnail?: NodeId;
+    type?: string;
+}, {
+    thumbnail?: CogniteFile;
+    revisions?: CognitePointCloudRevision[];
+}>;
+type Cognite360ImageModel = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    thumbnail?: NodeId;
+    type?: string;
+}, {
+    thumbnail?: CogniteFile;
+    collections?: Cognite360ImageCollection[];
+}>;
+type CogniteCADRevision = IndustrialModel<{
+    status?: string;
+    published?: boolean;
+    type?: string;
+    model3D?: NodeId;
+    revisionId?: number;
+}, {
+    model3D?: CogniteCADModel;
+}>;
+type CognitePointCloudRevision = IndustrialModel<{
+    status?: string;
+    published?: boolean;
+    type?: string;
+    model3D?: NodeId;
+    revisionId?: number;
+}, {
+    model3D?: CognitePointCloudModel;
+}>;
+type Cognite360ImageCollection = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    status?: string;
+    published?: boolean;
+    type?: string;
+    model3D?: NodeId;
+}, {
+    model3D?: Cognite360ImageModel;
+}>;
+type CogniteCADNode = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    object3D?: NodeId;
+    model3D?: NodeId;
+    cadNodeReference?: string;
+    revisions?: NodeId[];
+    treeIndexes?: number[];
+    subTreeSizes?: number[];
+}, {
+    object3D?: Cognite3DObject;
+    model3D?: CogniteCADModel;
+    revisions?: CogniteCADRevision[];
+}>;
+type CognitePointCloudVolume = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    object3D?: NodeId;
+    model3D?: NodeId;
+    volumeReferences?: string[];
+    revisions?: NodeId[];
+    volumeType?: string;
+    volume?: number[];
+    formatVersion?: string;
+}, {
+    object3D?: Cognite3DObject;
+    model3D?: CogniteCADModel;
+    revisions?: CogniteCADRevision[];
+}>;
+type Cognite360Image = IndustrialModel<{
+    translationX?: number;
+    translationY?: number;
+    translationZ?: number;
+    eulerRotationX?: number;
+    eulerRotationY?: number;
+    eulerRotationZ?: number;
+    scaleX?: number;
+    scaleY?: number;
+    scaleZ?: number;
+    front?: NodeId;
+    back?: NodeId;
+    left?: NodeId;
+    right?: NodeId;
+    top?: NodeId;
+    bottom?: NodeId;
+    collection360?: NodeId;
+    station360?: NodeId;
+    takenAt?: string;
+}, {
+    front?: CogniteFile;
+    back?: CogniteFile;
+    left?: CogniteFile;
+    right?: CogniteFile;
+    top?: CogniteFile;
+    bottom?: CogniteFile;
+    collection360?: Cognite360ImageCollection;
+    station360?: Cognite360ImageStation;
+}>;
+type Cognite360ImageStation = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    groupType?: string;
+}>;
+type Cognite360ImageAnnotation = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    sourceId?: string;
+    sourceContext?: string;
+    source?: NodeId;
+    sourceCreatedTime?: string;
+    sourceUpdatedTime?: string;
+    sourceCreatedUser?: string;
+    sourceUpdatedUser?: string;
+    confidence?: number;
+    status?: string;
+    polygon?: number[];
+    formatVersion?: string;
+}, {
+    source?: CogniteSourceSystem;
+}>;
+type CogniteAsset = IndustrialModel<{
+    object3D?: NodeId;
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    sourceId?: string;
+    sourceContext?: string;
+    source?: NodeId;
+    sourceCreatedTime?: string;
+    sourceUpdatedTime?: string;
+    sourceCreatedUser?: string;
+    sourceUpdatedUser?: string;
+    parent?: NodeId;
+    root?: NodeId;
+    path?: NodeId[];
+    pathLastUpdatedTime?: string;
+    assetClass?: NodeId;
+    type?: NodeId;
+}, {
+    object3D?: Cognite3DObject;
+    source?: CogniteSourceSystem;
+    parent?: CogniteAsset;
+    root?: CogniteAsset;
+    path?: CogniteAsset[];
+    assetClass?: CogniteAssetClass;
+    type?: CogniteAssetType;
+    children?: CogniteAsset[];
+    equipment?: CogniteEquipment[];
+}>;
+type CogniteAssetClass = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    code?: string;
+    standard?: string;
+}>;
+type CogniteAssetType = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    code?: string;
+    standard?: string;
+    assetClass?: NodeId;
+}, {
+    assetClass?: CogniteAssetClass;
+}>;
+type CogniteEquipment = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    sourceId?: string;
+    sourceContext?: string;
+    source?: NodeId;
+    sourceCreatedTime?: string;
+    sourceUpdatedTime?: string;
+    sourceCreatedUser?: string;
+    sourceUpdatedUser?: string;
+    asset?: NodeId;
+    serialNumber?: string;
+    manufacturer?: string;
+    equipmentType?: NodeId;
+    files?: NodeId[];
+}, {
+    source?: CogniteSourceSystem;
+    asset?: CogniteAsset;
+    equipmentType?: CogniteEquipmentType;
+    files?: CogniteFile[];
+}>;
+type CogniteEquipmentType = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    code?: string;
+    equipmentClass?: string;
+    standard?: string;
+    standardReference?: string;
+}>;
+type CogniteFile = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    sourceId?: string;
+    sourceContext?: string;
+    source?: NodeId;
+    sourceCreatedTime?: string;
+    sourceUpdatedTime?: string;
+    sourceCreatedUser?: string;
+    sourceUpdatedUser?: string;
+    assets?: NodeId[];
+    mimeType?: string;
+    directory?: string;
+    isUploaded?: boolean;
+    uploadedTime?: string;
+    category?: NodeId;
+}, {
+    source?: CogniteSourceSystem;
+    assets?: CogniteAsset[];
+    category?: CogniteFileCategory;
+}>;
+type CogniteFileCategory = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    code: string;
+    standard?: string;
+    standardReference?: string;
+}>;
+type CogniteActivity = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    sourceId?: string;
+    sourceContext?: string;
+    source?: NodeId;
+    sourceCreatedTime?: string;
+    sourceUpdatedTime?: string;
+    sourceCreatedUser?: string;
+    sourceUpdatedUser?: string;
+    startTime?: string;
+    endTime?: string;
+    scheduledStartTime?: string;
+    scheduledEndTime?: string;
+    assets?: NodeId[];
+    equipment?: NodeId[];
+    timeSeries?: NodeId[];
+}, {
+    source?: CogniteSourceSystem;
+    assets?: CogniteAsset[];
+    equipment?: CogniteEquipment[];
+    timeSeries?: CogniteTimeSeries[];
+}>;
+type CogniteTimeSeries = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    sourceId?: string;
+    sourceContext?: string;
+    source?: NodeId;
+    sourceCreatedTime?: string;
+    sourceUpdatedTime?: string;
+    sourceCreatedUser?: string;
+    sourceUpdatedUser?: string;
+    isStep: boolean;
+    type: string;
+    sourceUnit?: string;
+    unit?: NodeId;
+    assets?: NodeId[];
+    equipment?: NodeId[];
+    stateSet?: NodeId;
+}, {
+    source?: CogniteSourceSystem;
+    unit?: CogniteUnit;
+    assets?: CogniteAsset[];
+    equipment?: CogniteEquipment[];
+}>;
+type CogniteAnnotation = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    sourceId?: string;
+    sourceContext?: string;
+    source?: NodeId;
+    sourceCreatedTime?: string;
+    sourceUpdatedTime?: string;
+    sourceCreatedUser?: string;
+    sourceUpdatedUser?: string;
+    confidence?: number;
+    status?: string;
+}, {
+    source?: CogniteSourceSystem;
+}>;
+type CogniteDiagramAnnotation = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    sourceId?: string;
+    sourceContext?: string;
+    source?: NodeId;
+    sourceCreatedTime?: string;
+    sourceUpdatedTime?: string;
+    sourceCreatedUser?: string;
+    sourceUpdatedUser?: string;
+    confidence?: number;
+    status?: string;
+    startNodePageNumber?: number;
+    endNodePageNumber?: number;
+    startNodeXMin?: number;
+    startNodeXMax?: number;
+    startNodeYMin?: number;
+    startNodeYMax?: number;
+    startNodeText?: string;
+    endNodeXMin?: number;
+    endNodeXMax?: number;
+    endNodeYMin?: number;
+    endNodeYMax?: number;
+    endNodeText?: string;
+}, {
+    source?: CogniteSourceSystem;
+}>;
+type CogniteUnit = IndustrialModel<{
+    name?: string;
+    description?: string;
+    tags?: string[];
+    aliases?: string[];
+    symbol?: string;
+    quantity?: string;
+    source?: string;
+    sourceReference?: string;
+}>;
+interface CogniteCoreModelByView {
+    CogniteDescribable: CogniteDescribable;
+    CogniteSourceable: CogniteSourceable;
+    CogniteSourceSystem: CogniteSourceSystem;
+    CogniteSchedulable: CogniteSchedulable;
+    CogniteVisualizable: CogniteVisualizable;
+    Cognite3DTransformation: Cognite3DTransformation;
+    CogniteCubeMap: CogniteCubeMap;
+    Cognite3DObject: Cognite3DObject;
+    Cognite3DModel: Cognite3DModel;
+    CogniteCADModel: CogniteCADModel;
+    Cognite3DRevision: Cognite3DRevision;
+    CognitePointCloudModel: CognitePointCloudModel;
+    Cognite360ImageModel: Cognite360ImageModel;
+    CogniteCADRevision: CogniteCADRevision;
+    CognitePointCloudRevision: CognitePointCloudRevision;
+    Cognite360ImageCollection: Cognite360ImageCollection;
+    CogniteCADNode: CogniteCADNode;
+    CognitePointCloudVolume: CognitePointCloudVolume;
+    Cognite360Image: Cognite360Image;
+    Cognite360ImageStation: Cognite360ImageStation;
+    Cognite360ImageAnnotation: Cognite360ImageAnnotation;
+    CogniteAsset: CogniteAsset;
+    CogniteAssetClass: CogniteAssetClass;
+    CogniteAssetType: CogniteAssetType;
+    CogniteEquipment: CogniteEquipment;
+    CogniteEquipmentType: CogniteEquipmentType;
+    CogniteFile: CogniteFile;
+    CogniteFileCategory: CogniteFileCategory;
+    CogniteActivity: CogniteActivity;
+    CogniteTimeSeries: CogniteTimeSeries;
+    CogniteAnnotation: CogniteAnnotation;
+    CogniteDiagramAnnotation: CogniteDiagramAnnotation;
+    CogniteUnit: CogniteUnit;
+}
+type CogniteCoreModel<TView extends CogniteCoreViewExternalId> = CogniteCoreModelByView[TView];
+type CogniteCoreQueryExecutor<TView extends CogniteCoreViewExternalId> = {
+    <const TSelect extends QuerySelect<CogniteCoreModel<TView>>>(options: Omit<QueryOptions<CogniteCoreModel<TView>, TSelect>, "viewExternalId" | "select"> & {
+        select: TSelect & QuerySelect<CogniteCoreModel<TView>>;
+    }): Promise<QueryResult<QueryResultItem<CogniteCoreModel<TView>, TSelect>>>;
+    (options?: Omit<QueryOptions<CogniteCoreModel<TView>, undefined>, "viewExternalId" | "select"> & {
+        select?: undefined;
+    }): Promise<QueryResult<QueryResultItem<CogniteCoreModel<TView>, undefined>>>;
+};
+type CogniteCoreAggregateExecutor<TView extends CogniteCoreViewExternalId> = <const TOptions extends Omit<AggregateOptions<CogniteCoreModel<TView>>, "viewExternalId">>(options?: TOptions) => Promise<AggregateResult<AggregateResultItem<CogniteCoreModel<TView>, TOptions["groupBy"], TOptions["aggregate"]>>>;
+type CogniteCoreUpsertExecutor<TView extends CogniteCoreViewExternalId> = (options: Omit<UpsertOptions<CogniteCoreModel<TView>>, "viewExternalId">) => Promise<UpsertResult>;
+
+/** Data model id for Cognite Core v1. */
+declare const COGNITE_CORE_DATA_MODEL: {
+    space: string;
+    externalId: string;
+    version: string;
+};
+declare class CogniteCoreClient {
+    private readonly model;
+    constructor(client: CogniteClient, options?: IndustrialModelClientOptions);
+    query<TView extends CogniteCoreViewExternalId>(viewExternalId: TView): CogniteCoreQueryExecutor<TView>;
+    aggregate<TView extends CogniteCoreViewExternalId>(viewExternalId: TView): CogniteCoreAggregateExecutor<TView>;
+    upsert<TView extends CogniteCoreViewExternalId>(viewExternalId: TView): CogniteCoreUpsertExecutor<TView>;
+    delete<TItem extends NodeId>(items: TItem[]): Promise<DeleteResult>;
+}
+
+export { COGNITE_CORE_DATA_MODEL, type Cognite360Image, type Cognite360ImageAnnotation, type Cognite360ImageCollection, type Cognite360ImageModel, type Cognite360ImageStation, type Cognite3DModel, type Cognite3DObject, type Cognite3DRevision, type Cognite3DTransformation, type CogniteActivity, type CogniteAnnotation, type CogniteAsset, type CogniteAssetClass, type CogniteAssetType, type CogniteCADModel, type CogniteCADNode, type CogniteCADRevision, type CogniteCoreAggregateExecutor, CogniteCoreClient, type CogniteCoreModel, type CogniteCoreModelByView, type CogniteCoreQueryExecutor, type CogniteCoreUpsertExecutor, type CogniteCoreViewExternalId, type CogniteCubeMap, type CogniteDescribable, type CogniteDiagramAnnotation, type CogniteEquipment, type CogniteEquipmentType, type CogniteFile, type CogniteFileCategory, type CognitePointCloudModel, type CognitePointCloudRevision, type CognitePointCloudVolume, type CogniteSchedulable, type CogniteSourceSystem, type CogniteSourceable, type CogniteTimeSeries, type CogniteUnit, type CogniteVisualizable };