@twinfinity/twin 6.0.1 → 6.0.2

package/src/types/index.ts

@@ -1,6 +1,9 @@
-export * from './common';
-export * from './twin-api';
-export * from './asset-api';
-export * from './asset-batch-api';
-export * from './twin-file-api';
-export * from './generated';
+export * from './common';
+export * from './twin-api';
+export * from './asset-api';
+export * from './asset-batch-api';
+export * from './asset-types-api';
+export * from './asset-attachment-api';
+export * from './twin-permissions-api';
+export * from './twin-file-api';
+export * from './generated';

package/src/types/twin-api.ts

@@ -1,99 +1,99 @@
-import type { PropertySet, ElementQuantities, TwinSpecification, Diagnostics } from './generated';
-
-export interface TwinFileReference {
-    fileId: string;
-    fileVersion: number;
-    twinNodeId?: string;
-}
-
-export interface ListTwinItem {
-    id: string;
-    name: string;
-    etag: string;
-    propertySets?: PropertySet[];
-    computedPropertySets?: PropertySet[];
-    elementQuantities?: ElementQuantities[];
-    relatedContainerIds: string[];
-    version: number;
-    isDeleted?: boolean;
-    createdBy: string;
-    createdUtc: string;
-    modifiedBy: string;
-    modifiedUtc: string;
-}
-
-export interface TwinGet extends TwinSpecification {
-    id: string;
-    etag: string;
-    relatedContainerIds: string[];
-    version: number;
-    isDeleted?: boolean;
-    createdBy: string;
-    createdUtc: string;
-    modifiedBy: string;
-    modifiedUtc: string;
-    fileReferences: TwinFileReference[];
-    computedPropertySets?: PropertySet[];
-}
-
-export interface TwinPut extends TwinSpecification {
-    etag?: string;
-    relatedContainerIds: string[];
-    fileReferences?: TwinFileReference[];
-}
-
-export interface TwinDelete {
-    etag: string;
-}
-
-export interface TwinVersionContentResponse {
-    twinId: string;
-    twinVersion: number;
-    status: string;
-    processors: TwinProcessorResponse[];
-    content: TwinContentResponse[];
-    computedPropertySets: TwinComputedPropertySetsResponse[];
-}
-
-export interface TwinProcessorResponse {
-    processorId: string;
-    processorName: string;
-    processorDescription?: string;
-    status: string;
-}
-
-export interface TwinContentResponse {
-    id: string;
-    processorId: string;
-    format: string;
-    description?: string;
-    receivedAt: string;
-}
-
-export interface TwinComputedPropertySetsResponse {
-    processorId: string;
-    propertySets: PropertySet[];
-    receivedAt: string;
-}
-
-export interface TwinProcessorEvent {
-    id: string;
-    processorId: string;
-    eventType: string;
-    eventTimestampUtc: string;
-    details?: unknown;
-    message?: string;
-}
-
-export interface DiagnosticsSummary {
-    fatalCount: number;
-    errorCount: number;
-    warningCount: number;
-}
-
-export interface TwinDiagnosticsResponse {
-    twinId: string;
-    twinVersion: number;
-    summary: DiagnosticsSummary;
-    diagnostics: Diagnostics;
-}
+import type { PropertySet, ElementQuantities, TwinSpecification, Diagnostics } from './generated';
+
+export interface TwinFileReference {
+    fileId: string;
+    fileVersion: number;
+    twinNodeId?: string;
+}
+
+export interface ListTwinItem {
+    id: string;
+    name: string;
+    etag: string;
+    propertySets?: PropertySet[];
+    computedPropertySets?: PropertySet[];
+    elementQuantities?: ElementQuantities[];
+    relatedContainerIds: string[];
+    version: number;
+    isDeleted?: boolean;
+    createdBy: string;
+    createdUtc: string;
+    modifiedBy: string;
+    modifiedUtc: string;
+}
+
+export interface TwinGet extends TwinSpecification {
+    id: string;
+    etag: string;
+    relatedContainerIds: string[];
+    version: number;
+    isDeleted?: boolean;
+    createdBy: string;
+    createdUtc: string;
+    modifiedBy: string;
+    modifiedUtc: string;
+    fileReferences: TwinFileReference[];
+    computedPropertySets?: PropertySet[];
+}
+
+export interface TwinPut extends TwinSpecification {
+    etag?: string;
+    relatedContainerIds: string[];
+    fileReferences?: TwinFileReference[];
+}
+
+export interface TwinDelete {
+    etag: string;
+}
+
+export interface TwinVersionContentResponse {
+    twinId: string;
+    twinVersion: number;
+    status: string;
+    processors: TwinProcessorResponse[];
+    content: TwinContentResponse[];
+    computedPropertySets: TwinComputedPropertySetsResponse[];
+}
+
+export interface TwinProcessorResponse {
+    processorId: string;
+    processorName: string;
+    processorDescription?: string;
+    status: string;
+}
+
+export interface TwinContentResponse {
+    id: string;
+    processorId: string;
+    format: string;
+    description?: string;
+    receivedAt: string;
+}
+
+export interface TwinComputedPropertySetsResponse {
+    processorId: string;
+    propertySets: PropertySet[];
+    receivedAt: string;
+}
+
+export interface TwinProcessorEvent {
+    id: string;
+    processorId: string;
+    eventType: string;
+    eventTimestampUtc: string;
+    details?: unknown;
+    message?: string;
+}
+
+export interface DiagnosticsSummary {
+    fatalCount: number;
+    errorCount: number;
+    warningCount: number;
+}
+
+export interface TwinDiagnosticsResponse {
+    twinId: string;
+    twinVersion: number;
+    summary: DiagnosticsSummary;
+    diagnostics: Diagnostics;
+}

package/src/types/twin-file-api.ts

@@ -1,67 +1,67 @@
-export interface TwinFileTransform {
-    qx?: number;
-    qy?: number;
-    qz?: number;
-    qw?: number;
-    sx?: number;
-    sy?: number;
-    sz?: number;
-    x?: number;
-    y?: number;
-    z?: number;
-}
-
-export interface TwinFileGet {
-    id: string;
-    twinId: string;
-    version: number;
-    source: TwinFileSource;
-    name: string;
-    comment?: string;
-    quality: number;
-    etag: string;
-    isDeleted: boolean;
-    createdBy: string;
-    createdUtc: string;
-    modifiedBy: string;
-    modifiedUtc: string;
-    transform?: TwinFileTransform;
-}
-
-export interface TwinFileSource {
-    changeId: string;
-    changeVersion: number;
-    sourceType: string;
-}
-
-export interface TwinFilePut {
-    source: TwinFileSource;
-    name: string;
-    comment?: string;
-    quality: number | null;
-    etag?: string;
-    isDeleted?: boolean;
-    transform?: TwinFileTransform;
-}
-
-export interface TwinFileDelete {
-    etag: string;
-}
-
-export interface TwinFileRestore {
-    etag: string;
-}
-
-export interface TwinFileListOptions {
-    includeDeleted?: boolean;
-    checkedIn?: boolean;
-    version?: number;
-    page?: string;
-    limit?: number;
-}
-
-export interface TwinFileVersionListOptions {
-    includeDeleted?: boolean;
-    offset?: number;
-    limit?: number;
-}
+export interface TwinFileTransform {
+    qx?: number;
+    qy?: number;
+    qz?: number;
+    qw?: number;
+    sx?: number;
+    sy?: number;
+    sz?: number;
+    x?: number;
+    y?: number;
+    z?: number;
+}
+
+export interface TwinFileGet {
+    id: string;
+    twinId: string;
+    version: number;
+    source: TwinFileSource;
+    name: string;
+    comment?: string;
+    quality: number;
+    etag: string;
+    isDeleted: boolean;
+    createdBy: string;
+    createdUtc: string;
+    modifiedBy: string;
+    modifiedUtc: string;
+    transform?: TwinFileTransform;
+}
+
+export interface TwinFileSource {
+    changeId: string;
+    changeVersion: number;
+    sourceType: string;
+}
+
+export interface TwinFilePut {
+    source: TwinFileSource;
+    name: string;
+    comment?: string;
+    quality: number | null;
+    etag?: string;
+    isDeleted?: boolean;
+    transform?: TwinFileTransform;
+}
+
+export interface TwinFileDelete {
+    etag: string;
+}
+
+export interface TwinFileRestore {
+    etag: string;
+}
+
+export interface TwinFileListOptions {
+    includeDeleted?: boolean;
+    checkedIn?: boolean;
+    version?: number;
+    page?: string;
+    limit?: number;
+}
+
+export interface TwinFileVersionListOptions {
+    includeDeleted?: boolean;
+    offset?: number;
+    limit?: number;
+}

package/src/types/twin-permissions-api.ts

@@ -0,0 +1,20 @@
+/**
+ * Named, customer-scoped capability the caller can exercise against the
+ * Twin service. Returned by `GET /twins/permissions/me`. Forward-compatible:
+ * unknown strings should be treated as "not granted" and ignored, so adding
+ * a new capability on the backend is a non-breaking change for clients
+ * compiled against older types.
+ */
+export type TwinCapability = 'ViewAssetTypes' | 'EditAssetTypes';
+
+/**
+ * Response body for `GET /twins/permissions/me`. The `permissions` array
+ * lists only capabilities the caller actually holds; absence means "not
+ * granted." Use `permissions.includes('EditAssetTypes')` etc. for gating.
+ *
+ * Wrapped under a key (rather than a bare array) so future fields — an
+ * etag, an identity echo, expiry — can be added without a shape break.
+ */
+export interface MyPermissions {
+    permissions: TwinCapability[];
+}