@twinfinity/twin 6.0.1 → 6.0.2-ci.29168

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

@@ -1,88 +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>[];
-}
+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/asset-types-api.ts

@@ -0,0 +1,86 @@
+// Wire types for asset categories and asset types (TWINS-3643).
+// See backend/services/Twinfinity.Twin/Controllers/Model/AssetCategoryDtos.cs
+// and AssetTypeDtos.cs.
+
+export interface AssetCategoryGet {
+    id: string;
+    stringId: string;
+    /** Latest version pointer. Server-assigned, increments on every successful upsert/delete/restore. */
+    version: number;
+    title: string;
+    description?: string | null;
+    etag: string;
+    /** Always present — see backend AssetCategoryGet.IsDeleted JSDoc. */
+    isDeleted: boolean;
+    createdBy: string;
+    createdUtc: string;
+    modifiedBy: string;
+    modifiedUtc: string;
+}
+
+export interface AssetCategoryPut {
+    /** Empty/missing for first writes; required to match on subsequent updates. */
+    etag?: string | null;
+    /** Slug `^[A-Za-z0-9_][A-Za-z0-9_-]*$`, unique across categories. */
+    stringId: string;
+    title: string;
+    description?: string | null;
+}
+
+export interface AssetCategoryDelete {
+    etag: string;
+}
+
+export interface AssetTypeGet {
+    id: string;
+    categoryId: string;
+    stringId: string;
+    /** Latest version pointer. Server-assigned, increments on every successful upsert. */
+    version: number;
+    title: string;
+    description?: string | null;
+    metadataSchema: Record<string, unknown>;
+    etag: string;
+    /** Always present — see backend AssetTypeGet.IsDeleted JSDoc. */
+    isDeleted: boolean;
+    createdBy: string;
+    createdUtc: string;
+    modifiedBy: string;
+    modifiedUtc: string;
+}
+
+export interface AssetTypePut {
+    /** Empty/missing for first writes; required to match on subsequent updates. */
+    etag?: string | null;
+    /** Slug `^[A-Za-z0-9_][A-Za-z0-9_-]*$`, unique within the parent category. */
+    stringId: string;
+    title: string;
+    description?: string | null;
+    /** TwinfinityMetadataSchema document. Validated against the meta-schema at the API boundary. */
+    metadataSchema: Record<string, unknown>;
+}
+
+export interface AssetTypeDelete {
+    etag: string;
+}
+
+/**
+ * One entry in an {@link AssetCatalogResponse}: a category and its latest
+ * non-deleted types in title order. The wire shapes for category/type rows
+ * are reused from the standalone CRUD endpoints so the same components can
+ * render rows from either source.
+ */
+export interface AssetCatalogCategory {
+    category: AssetCategoryGet;
+    types: AssetTypeGet[];
+}
+
+/**
+ * Wire shape of `GET /asset-type-catalog`: the customer's asset-type
+ * catalog, categories nested with their latest non-deleted types and full
+ * metadata schemas. One round-trip is enough to populate a picker dropdown
+ * and the per-type metadata form.
+ */
+export interface AssetCatalogResponse {
+    categories: AssetCatalogCategory[];
+}

package/src/types/common.ts

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