@twinfinity/twin 5.0.3-ci.27942

package/src/errors.ts

@@ -0,0 +1,107 @@
+import type { TwinGet, AssetGet, TwinFileGet, AssetBatchResponse } from './types';
+
+export interface TwinErrorBody {
+    detail: string;
+    cause: string;
+    item?: {
+        kind: string;
+        id: string;
+        version?: number;
+        field?: string;
+    };
+}
+
+export class TwinValidationError extends Error {
+    public readonly errorBody?: TwinErrorBody;
+
+    constructor(message: string, errorBody?: TwinErrorBody) {
+        super(message);
+        this.name = 'TwinValidationError';
+        this.errorBody = errorBody;
+    }
+}
+
+export class TwinConflictError extends Error {
+    public readonly currentTwin: TwinGet;
+
+    constructor(message: string, currentTwin: TwinGet) {
+        super(message);
+        this.name = 'TwinConflictError';
+        this.currentTwin = currentTwin;
+    }
+}
+
+export class TwinNotFoundError extends Error {
+    constructor(message: string) {
+        super(message);
+        this.name = 'TwinNotFoundError';
+    }
+}
+
+export class ProcessorNotFoundError extends Error {
+    constructor(message: string) {
+        super(message);
+        this.name = 'ProcessorNotFoundError';
+    }
+}
+
+export class AssetValidationError extends Error {
+    constructor(message: string) {
+        super(message);
+        this.name = 'AssetValidationError';
+    }
+}
+
+export class AssetConflictError extends Error {
+    public readonly currentAsset: AssetGet;
+
+    constructor(message: string, currentAsset: AssetGet) {
+        super(message);
+        this.name = 'AssetConflictError';
+        this.currentAsset = currentAsset;
+    }
+}
+
+export class AssetNotFoundError extends Error {
+    constructor(message: string) {
+        super(message);
+        this.name = 'AssetNotFoundError';
+    }
+}
+
+export class AssetBatchError extends Error {
+    public readonly response: AssetBatchResponse;
+
+    constructor(message: string, response: AssetBatchResponse) {
+        super(message);
+        this.name = 'AssetBatchError';
+        this.response = response;
+    }
+}
+
+export class TwinFileValidationError extends Error {
+    public readonly errorBody?: TwinErrorBody;
+
+    constructor(message: string, errorBody?: TwinErrorBody) {
+        super(message);
+        this.name = 'TwinFileValidationError';
+        this.errorBody = errorBody;
+    }
+}
+
+export class TwinFileConflictError extends Error {
+    public readonly currentTwinFile: TwinFileGet;
+
+    constructor(message: string, currentTwinFile: TwinFileGet) {
+        super(message);
+        this.name = 'TwinFileConflictError';
+        this.currentTwinFile = currentTwinFile;
+    }
+}
+
+export class TwinFileNotFoundError extends Error {
+    constructor(message: string) {
+        super(message);
+        this.name = 'TwinFileNotFoundError';
+    }
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export { type ITwinClient, TwinClient } from './TwinClient';
+export * from './types';
+export * from './errors';

package/src/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "../../tsconfig.common.json",
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "noEmit": false,
+    "outDir": "../dist"
+  },
+  "include": ["**/*.ts"],
+  "references": [
+    { "path": "../../twinfinity-authentication/src" },
+    { "path": "../../twinfinity-t8-client-model/src" }
+  ]
+}

package/src/types/Twin.ts

@@ -0,0 +1,7 @@
+import { T8ClientModel } from '@twinfinity/t8-client-model';
+
+export class Twin<TProject, TProduct, TEntityType, TUnit> {
+    id: string;
+    version: number;
+    model?: T8ClientModel<TProject, TProduct, TEntityType, TUnit>;
+}

package/src/types/TwinGeometryInfo.ts

@@ -0,0 +1,7 @@
+import type { T8GIModelGeneric } from '@twinfinity/t8-client-model';
+
+export interface TwinGeometryInfo<TMeshDescriptor, TStyle, TRegion> {
+    id: string;
+    version: number;
+    model?: T8GIModelGeneric<TMeshDescriptor, TStyle, TRegion>;
+}

package/src/types/asset-api.ts

@@ -0,0 +1,60 @@
+export interface AssetListItem {
+    id: string;
+    name: string;
+    category?: string;
+    type?: string;
+    twinReference?: string;
+    parentIfcGid?: string;
+    ifcGid?: string;
+    etag: string;
+    createdAt: string;
+    isDeleted?: boolean;
+}
+
+export interface AssetPosition {
+    x?: number;
+    y?: number;
+    z?: number;
+}
+
+export interface AssetGet {
+    id: string;
+    name: string;
+    category?: string;
+    type?: string;
+    ifcGid?: string;
+    twinReference?: string;
+    position?: AssetPosition;
+    parentIfcGid?: string;
+    metadata?: Record<string, unknown>;
+    etag: string;
+    createdUtc: string;
+    createdBy: string;
+    modifiedUtc: string;
+    modifiedBy: string;
+    isDeleted?: boolean;
+}
+
+export interface AssetPost {
+    id?: string;
+    name: string;
+    category?: string;
+    type?: string;
+    ifcGid?: string;
+    position?: AssetPosition;
+    parentIfcGid?: string;
+    metadata?: Record<string, unknown>;
+    twinReference?: string;
+}
+
+export interface AssetPut {
+    etag: string;
+    name: string;
+    category?: string;
+    type?: string;
+    ifcGid?: string;
+    position?: AssetPosition;
+    parentIfcGid?: string;
+    metadata?: Record<string, unknown>;
+    twinReference?: string;
+}

package/src/types/asset-batch-api.ts

@@ -0,0 +1,88 @@
+import type { AssetGet, AssetPosition } from './asset-api';
+
+export type AssetBatchOperation = AssetBatchUpsertOperation | AssetBatchDeleteOperation | AssetBatchRestoreOperation;
+
+export interface AssetBatchUpsertOperation {
+    operation: 'upsert';
+    id: string;
+    item: AssetBatchUpsertItem;
+}
+
+export interface AssetBatchDeleteOperation {
+    operation: 'delete';
+    id: string;
+    item: { etag: string };
+}
+
+export interface AssetBatchRestoreOperation {
+    operation: 'restore';
+    id: string;
+    item: { etag: string };
+}
+
+export interface AssetBatchUpsertItem {
+    etag?: string | null;
+    name: string;
+    category?: string;
+    type?: string;
+    ifcGid?: string;
+    position?: AssetPosition;
+    parentIfcGid?: string;
+    metadata?: Record<string, unknown>;
+    twinReference?: string;
+}
+
+export interface AssetBatchRequest {
+    operations: AssetBatchOperation[];
+}
+
+export interface AssetBatchGetRequest {
+    ids: string[];
+}
+
+export type AssetBatchOperationStatus =
+    | 'upserted'
+    | 'deleted'
+    | 'restored'
+    | 'reverted'
+    | 'conflicted'
+    | 'notFound'
+    | 'forbidden'
+    | 'badRequest';
+
+export type AssetBatchGetStatus = 'found' | 'notFound';
+
+export interface BatchSummary {
+    total: number;
+    succeeded: number;
+    failed: number;
+}
+
+export interface BatchItemError {
+    detail: string;
+    cause: string;
+    referencedItem?: {
+        kind: string;
+        id?: string;
+        field?: string;
+        version?: number;
+    };
+}
+
+export interface BatchItemResult<TStatus extends string> {
+    index: number;
+    status: TStatus;
+    statusCode?: number;
+    item?: AssetGet;
+    error?: BatchItemError;
+}
+
+export interface AssetBatchResponse {
+    summary?: BatchSummary;
+    results: BatchItemResult<AssetBatchOperationStatus>[];
+}
+
+export interface AssetBatchGetResponse {
+    summary: BatchSummary;
+    results: BatchItemResult<AssetBatchGetStatus>[];
+}

package/src/types/common.ts

@@ -0,0 +1,10 @@
+export interface Pagination {
+    limit: number;
+    maxLimit: number;
+    nextPage: string;
+}
+
+export interface PaginatedResponse<T> {
+    data: T[];
+    pagination: Pagination;
+}