@alliumcloud/configurator-service 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,340 @@
+/**
+ * Shared primitive types and SDK config used across all modules.
+ */
+type ConfiguratorServiceSDKConfig = {
+    apiKey: string;
+    jwksUri: string;
+    accessTokenProvider: () => string | Promise<string>;
+    timeout?: number;
+    /** @internal - dev only, not for production use */
+    _devBaseUrl?: string;
+};
+type SpaceItemType = "RuntimeModel" | "SpatialMedia" | "LibraryModel" | "RuntimeStream" | "BridgeToolkitSettings" | "Configurator" | "ConfiguratorObject";
+type ConfiguratorType = "string" | "number" | "boolean" | "enum" | "trigger" | "image" | "String" | "Number" | "Bool" | "Enum" | "Trigger" | "Image";
+type Vector3 = {
+    x: number;
+    y: number;
+    z: number;
+};
+type SpaceContext = {
+    orgId: string;
+    spaceId: string;
+    type: SpaceItemType;
+    name: string;
+    position: Vector3;
+    rotation: Vector3;
+    offsetUpRotation: number;
+    thumb?: string;
+    isLocked?: boolean;
+    user?: string;
+};
+
+type SpatialMediaTypes = "video" | "link";
+type SpatialMediaBase = Omit<SpaceContext, "type"> & {
+    type: "SpatialMedia";
+    mediaType: SpatialMediaTypes;
+    url: string;
+    attenuation: number;
+};
+type CreateVideoInput = Omit<SpatialMediaBase, "mediaType"> & {
+    mediaType: "video";
+    volume: number;
+    loop: boolean;
+    audioOnly: boolean;
+    showPreview: boolean;
+    autoplay?: boolean;
+};
+type UpdateVideoInput = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+    url?: string;
+    volume?: number;
+    attenuation?: number;
+    loop?: boolean;
+    audioOnly?: boolean;
+    showPreview?: boolean;
+};
+type CreateLinkInput = Omit<SpatialMediaBase, "mediaType"> & {
+    mediaType: "link";
+    isPortrait: boolean;
+    openInNewTab?: boolean;
+    displayName?: string;
+};
+type UpdateLinkInput = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+    url?: string;
+    name?: string;
+    openInNewTab?: boolean;
+    isPortrait?: boolean;
+};
+type CreateStreamInput = Omit<SpaceContext, "type"> & {
+    type: "RuntimeStream";
+    spaceStreamId: string;
+    scale?: Vector3;
+    autoScale?: boolean;
+    offsetUniformScale?: number;
+    name: string;
+    attenuation?: number;
+    volume?: number;
+    audioOnly?: boolean;
+};
+type UpdateStreamInput = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+    audioOnly?: boolean;
+    curvature?: number;
+    aspectRatio?: "4:3" | "16:9";
+    attenuation?: number;
+    volume?: number;
+};
+
+/**
+ * Media Module - Operations
+ */
+
+interface MediaHandle {
+    addVideo(data: CreateVideoInput): Promise<void>;
+    updateVideo(spaceItemId: string, data: UpdateVideoInput): Promise<void>;
+    addStream(data: CreateStreamInput): Promise<void>;
+    updateStream(spaceItemId: string, data: UpdateStreamInput): Promise<void>;
+    addLink(data: CreateLinkInput): Promise<void>;
+    updateLink(spaceItemId: string, data: UpdateLinkInput): Promise<void>;
+}
+
+type ModelAuthor = {
+    username: string;
+    profileUrl: string;
+};
+type ModelGlbInfo = {
+    faceCount?: number;
+    textureCount?: number;
+    size?: number;
+    vertexCount?: number;
+    textureMaxResolution?: number;
+};
+type ModelMetadata = {
+    uid?: string;
+    viewerUrl?: string;
+    author?: ModelAuthor;
+    license?: string;
+    glb?: ModelGlbInfo;
+};
+type CreateSketchfabObjectInput = Omit<SpaceContext, "type"> & {
+    type: "RuntimeModel";
+    gltfUrl?: string;
+    materialOverrideId: string;
+    scale: Vector3;
+    autoScale: boolean;
+    offsetUniformScale: number;
+    collisionsEnabled: boolean;
+    currentAnimation?: string;
+    availableAnimations?: string[];
+    metadata?: ModelMetadata;
+    thumb?: string;
+    sketchfabTempUrl?: string;
+};
+type UpdateSketchfabObjectInput = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+    collisionsEnabled?: boolean;
+    currentAnimation?: string;
+};
+
+/**
+ * Sketchfab Module - 3D Object Operations
+ */
+
+interface SketchfabHandle {
+    addObject(data: CreateSketchfabObjectInput): Promise<void>;
+    updateObject(spaceItemId: string, data: UpdateSketchfabObjectInput): Promise<void>;
+}
+
+type TransformItemContext = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+};
+type UpdatePositionInput = TransformItemContext & {
+    position: Vector3;
+};
+type UpdateRotationInput = TransformItemContext & {
+    rotation: Vector3;
+    offsetUpRotation?: number;
+};
+type UpdateScaleInput = TransformItemContext & {
+    scale?: Vector3;
+    offsetUniformScale: number;
+};
+type SnapToGroundInput = TransformItemContext;
+
+/**
+ * Transform Module - Position, Rotation, Scale Operations
+ */
+
+interface TransformHandle {
+    updatePosition(spaceItemId: string, data: UpdatePositionInput): Promise<void>;
+    updateRotation(spaceItemId: string, data: UpdateRotationInput): Promise<void>;
+    updateScale(spaceItemId: string, data: UpdateScaleInput): Promise<void>;
+    snapToGround(spaceItemId: string, data: SnapToGroundInput): Promise<void>;
+}
+
+type LockLayerItemInput = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+    isLocked: boolean;
+};
+type RenameLayerItemInput = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+    name: string;
+};
+type DeleteLayerItemInput = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+};
+type DeleteAllLayerItemsInput = {
+    orgId: string;
+    spaceId: string;
+};
+
+/**
+ * Layer Module - Lock, Rename, Delete Operations
+ */
+
+interface LayerHandle {
+    lockItem(spaceItemId: string, data: LockLayerItemInput): Promise<void>;
+    renameItem(spaceItemId: string, data: RenameLayerItemInput): Promise<void>;
+    deleteItem(spaceItemId: string, data: DeleteLayerItemInput): Promise<void>;
+    deleteAll(data: DeleteAllLayerItemsInput): Promise<void>;
+}
+
+type ConfiguratorItemSchema = {
+    displayName: string;
+    type: ConfiguratorType;
+    default: string | number | boolean;
+    values?: (string | number)[];
+    max?: number;
+    min?: number;
+    step?: number;
+    isPersisted?: boolean;
+    isNetworked?: boolean;
+};
+type CreateConfiguratorItemInput = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+    itemTemplateId: string;
+    name: string;
+    levelFilePath?: string;
+    denormalizeOnUpdate: boolean;
+    currentState?: string | number | boolean;
+    schema: ConfiguratorItemSchema;
+};
+type UpdateConfiguratorItemStateInput = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+    currentState: string | number | boolean;
+};
+
+/**
+ * Configurator Items Module - Level-wide property operations
+ */
+
+interface ConfiguratorItemsHandle {
+    create(data: CreateConfiguratorItemInput): Promise<void>;
+    updateState(spaceItemId: string, data: UpdateConfiguratorItemStateInput): Promise<void>;
+}
+
+type ObjectConfigurationValue = {
+    displayName: string;
+    type: ConfiguratorType;
+    currentState: string | number | boolean;
+    default: string | number | boolean;
+    max?: number;
+    min?: number;
+    step?: number;
+    values: (string | number)[];
+    displayType?: "image" | "dropdown";
+    valuesImages?: {
+        displayName: string;
+        thumb?: string;
+    }[];
+};
+type EnumObjectConfigurationValue = {
+    displayName: string;
+    type: "enum";
+    currentState: string | number;
+    default: string | number;
+    values: (string | number)[];
+    displayType: "image" | "dropdown";
+    max?: number;
+    min?: number;
+    step?: number;
+    valuesImages?: {
+        displayName: string;
+        thumb?: string;
+    }[];
+};
+type ConfigurationMap = {
+    [key: string]: ObjectConfigurationValue | EnumObjectConfigurationValue;
+};
+type CreateConfiguratorObjectInput = Omit<SpaceContext, "type"> & {
+    type: "ConfiguratorObject";
+    ueId: string;
+    versionId: string;
+    scale: Vector3;
+    offsetUniformScale: number;
+    configuration: ConfigurationMap;
+};
+type UpdateConfiguratorObjectConfigInput = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+    configuration: ConfigurationMap;
+};
+
+/**
+ * Configurator Objects Module - UE Actor placement and configuration
+ */
+
+interface ConfiguratorObjectsHandle {
+    create(data: CreateConfiguratorObjectInput): Promise<void>;
+    updateConfiguration(spaceItemId: string, data: UpdateConfiguratorObjectConfigInput): Promise<void>;
+}
+
+/**
+ * SDK Error factories.
+ */
+interface AlliumError extends Error {
+    readonly code: string;
+}
+/** Type guard — works for all Allium error factories */
+declare function isAlliumError(err: unknown): err is AlliumError;
+
+interface ConfiguratorSDKHandle {
+    media: MediaHandle;
+    sketchfab: SketchfabHandle;
+    transform: TransformHandle;
+    layer: LayerHandle;
+    configuratorItems: ConfiguratorItemsHandle;
+    configuratorObjects: ConfiguratorObjectsHandle;
+}
+declare function createConfiguratorSDK(config: ConfiguratorServiceSDKConfig): ConfiguratorSDKHandle;
+declare const ConfiguratorSDK: {
+    /**
+     * Create a new SDK client instance.
+     * @param config  SDK configuration — apiKey is required, timeout is optional.
+     */
+    readonly create: (config: ConfiguratorServiceSDKConfig) => ConfiguratorSDKHandle;
+};
+
+export { type AlliumError, type ConfiguratorSDKHandle, type ConfiguratorServiceSDKConfig, type CreateConfiguratorItemInput, type CreateConfiguratorObjectInput, type CreateLinkInput, type CreateSketchfabObjectInput, type CreateStreamInput, type CreateVideoInput, type DeleteAllLayerItemsInput, type DeleteLayerItemInput, type LockLayerItemInput, type RenameLayerItemInput, type SnapToGroundInput, type UpdateConfiguratorItemStateInput, type UpdateConfiguratorObjectConfigInput, type UpdateLinkInput, type UpdatePositionInput, type UpdateRotationInput, type UpdateScaleInput, type UpdateSketchfabObjectInput, type UpdateStreamInput, type UpdateVideoInput, createConfiguratorSDK, ConfiguratorSDK as default, isAlliumError };

package/dist/index.d.ts

@@ -0,0 +1,340 @@
+/**
+ * Shared primitive types and SDK config used across all modules.
+ */
+type ConfiguratorServiceSDKConfig = {
+    apiKey: string;
+    jwksUri: string;
+    accessTokenProvider: () => string | Promise<string>;
+    timeout?: number;
+    /** @internal - dev only, not for production use */
+    _devBaseUrl?: string;
+};
+type SpaceItemType = "RuntimeModel" | "SpatialMedia" | "LibraryModel" | "RuntimeStream" | "BridgeToolkitSettings" | "Configurator" | "ConfiguratorObject";
+type ConfiguratorType = "string" | "number" | "boolean" | "enum" | "trigger" | "image" | "String" | "Number" | "Bool" | "Enum" | "Trigger" | "Image";
+type Vector3 = {
+    x: number;
+    y: number;
+    z: number;
+};
+type SpaceContext = {
+    orgId: string;
+    spaceId: string;
+    type: SpaceItemType;
+    name: string;
+    position: Vector3;
+    rotation: Vector3;
+    offsetUpRotation: number;
+    thumb?: string;
+    isLocked?: boolean;
+    user?: string;
+};
+
+type SpatialMediaTypes = "video" | "link";
+type SpatialMediaBase = Omit<SpaceContext, "type"> & {
+    type: "SpatialMedia";
+    mediaType: SpatialMediaTypes;
+    url: string;
+    attenuation: number;
+};
+type CreateVideoInput = Omit<SpatialMediaBase, "mediaType"> & {
+    mediaType: "video";
+    volume: number;
+    loop: boolean;
+    audioOnly: boolean;
+    showPreview: boolean;
+    autoplay?: boolean;
+};
+type UpdateVideoInput = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+    url?: string;
+    volume?: number;
+    attenuation?: number;
+    loop?: boolean;
+    audioOnly?: boolean;
+    showPreview?: boolean;
+};
+type CreateLinkInput = Omit<SpatialMediaBase, "mediaType"> & {
+    mediaType: "link";
+    isPortrait: boolean;
+    openInNewTab?: boolean;
+    displayName?: string;
+};
+type UpdateLinkInput = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+    url?: string;
+    name?: string;
+    openInNewTab?: boolean;
+    isPortrait?: boolean;
+};
+type CreateStreamInput = Omit<SpaceContext, "type"> & {
+    type: "RuntimeStream";
+    spaceStreamId: string;
+    scale?: Vector3;
+    autoScale?: boolean;
+    offsetUniformScale?: number;
+    name: string;
+    attenuation?: number;
+    volume?: number;
+    audioOnly?: boolean;
+};
+type UpdateStreamInput = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+    audioOnly?: boolean;
+    curvature?: number;
+    aspectRatio?: "4:3" | "16:9";
+    attenuation?: number;
+    volume?: number;
+};
+
+/**
+ * Media Module - Operations
+ */
+
+interface MediaHandle {
+    addVideo(data: CreateVideoInput): Promise<void>;
+    updateVideo(spaceItemId: string, data: UpdateVideoInput): Promise<void>;
+    addStream(data: CreateStreamInput): Promise<void>;
+    updateStream(spaceItemId: string, data: UpdateStreamInput): Promise<void>;
+    addLink(data: CreateLinkInput): Promise<void>;
+    updateLink(spaceItemId: string, data: UpdateLinkInput): Promise<void>;
+}
+
+type ModelAuthor = {
+    username: string;
+    profileUrl: string;
+};
+type ModelGlbInfo = {
+    faceCount?: number;
+    textureCount?: number;
+    size?: number;
+    vertexCount?: number;
+    textureMaxResolution?: number;
+};
+type ModelMetadata = {
+    uid?: string;
+    viewerUrl?: string;
+    author?: ModelAuthor;
+    license?: string;
+    glb?: ModelGlbInfo;
+};
+type CreateSketchfabObjectInput = Omit<SpaceContext, "type"> & {
+    type: "RuntimeModel";
+    gltfUrl?: string;
+    materialOverrideId: string;
+    scale: Vector3;
+    autoScale: boolean;
+    offsetUniformScale: number;
+    collisionsEnabled: boolean;
+    currentAnimation?: string;
+    availableAnimations?: string[];
+    metadata?: ModelMetadata;
+    thumb?: string;
+    sketchfabTempUrl?: string;
+};
+type UpdateSketchfabObjectInput = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+    collisionsEnabled?: boolean;
+    currentAnimation?: string;
+};
+
+/**
+ * Sketchfab Module - 3D Object Operations
+ */
+
+interface SketchfabHandle {
+    addObject(data: CreateSketchfabObjectInput): Promise<void>;
+    updateObject(spaceItemId: string, data: UpdateSketchfabObjectInput): Promise<void>;
+}
+
+type TransformItemContext = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+};
+type UpdatePositionInput = TransformItemContext & {
+    position: Vector3;
+};
+type UpdateRotationInput = TransformItemContext & {
+    rotation: Vector3;
+    offsetUpRotation?: number;
+};
+type UpdateScaleInput = TransformItemContext & {
+    scale?: Vector3;
+    offsetUniformScale: number;
+};
+type SnapToGroundInput = TransformItemContext;
+
+/**
+ * Transform Module - Position, Rotation, Scale Operations
+ */
+
+interface TransformHandle {
+    updatePosition(spaceItemId: string, data: UpdatePositionInput): Promise<void>;
+    updateRotation(spaceItemId: string, data: UpdateRotationInput): Promise<void>;
+    updateScale(spaceItemId: string, data: UpdateScaleInput): Promise<void>;
+    snapToGround(spaceItemId: string, data: SnapToGroundInput): Promise<void>;
+}
+
+type LockLayerItemInput = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+    isLocked: boolean;
+};
+type RenameLayerItemInput = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+    name: string;
+};
+type DeleteLayerItemInput = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+};
+type DeleteAllLayerItemsInput = {
+    orgId: string;
+    spaceId: string;
+};
+
+/**
+ * Layer Module - Lock, Rename, Delete Operations
+ */
+
+interface LayerHandle {
+    lockItem(spaceItemId: string, data: LockLayerItemInput): Promise<void>;
+    renameItem(spaceItemId: string, data: RenameLayerItemInput): Promise<void>;
+    deleteItem(spaceItemId: string, data: DeleteLayerItemInput): Promise<void>;
+    deleteAll(data: DeleteAllLayerItemsInput): Promise<void>;
+}
+
+type ConfiguratorItemSchema = {
+    displayName: string;
+    type: ConfiguratorType;
+    default: string | number | boolean;
+    values?: (string | number)[];
+    max?: number;
+    min?: number;
+    step?: number;
+    isPersisted?: boolean;
+    isNetworked?: boolean;
+};
+type CreateConfiguratorItemInput = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+    itemTemplateId: string;
+    name: string;
+    levelFilePath?: string;
+    denormalizeOnUpdate: boolean;
+    currentState?: string | number | boolean;
+    schema: ConfiguratorItemSchema;
+};
+type UpdateConfiguratorItemStateInput = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+    currentState: string | number | boolean;
+};
+
+/**
+ * Configurator Items Module - Level-wide property operations
+ */
+
+interface ConfiguratorItemsHandle {
+    create(data: CreateConfiguratorItemInput): Promise<void>;
+    updateState(spaceItemId: string, data: UpdateConfiguratorItemStateInput): Promise<void>;
+}
+
+type ObjectConfigurationValue = {
+    displayName: string;
+    type: ConfiguratorType;
+    currentState: string | number | boolean;
+    default: string | number | boolean;
+    max?: number;
+    min?: number;
+    step?: number;
+    values: (string | number)[];
+    displayType?: "image" | "dropdown";
+    valuesImages?: {
+        displayName: string;
+        thumb?: string;
+    }[];
+};
+type EnumObjectConfigurationValue = {
+    displayName: string;
+    type: "enum";
+    currentState: string | number;
+    default: string | number;
+    values: (string | number)[];
+    displayType: "image" | "dropdown";
+    max?: number;
+    min?: number;
+    step?: number;
+    valuesImages?: {
+        displayName: string;
+        thumb?: string;
+    }[];
+};
+type ConfigurationMap = {
+    [key: string]: ObjectConfigurationValue | EnumObjectConfigurationValue;
+};
+type CreateConfiguratorObjectInput = Omit<SpaceContext, "type"> & {
+    type: "ConfiguratorObject";
+    ueId: string;
+    versionId: string;
+    scale: Vector3;
+    offsetUniformScale: number;
+    configuration: ConfigurationMap;
+};
+type UpdateConfiguratorObjectConfigInput = {
+    orgId: string;
+    spaceId: string;
+    spaceItemId: string;
+    configuration: ConfigurationMap;
+};
+
+/**
+ * Configurator Objects Module - UE Actor placement and configuration
+ */
+
+interface ConfiguratorObjectsHandle {
+    create(data: CreateConfiguratorObjectInput): Promise<void>;
+    updateConfiguration(spaceItemId: string, data: UpdateConfiguratorObjectConfigInput): Promise<void>;
+}
+
+/**
+ * SDK Error factories.
+ */
+interface AlliumError extends Error {
+    readonly code: string;
+}
+/** Type guard — works for all Allium error factories */
+declare function isAlliumError(err: unknown): err is AlliumError;
+
+interface ConfiguratorSDKHandle {
+    media: MediaHandle;
+    sketchfab: SketchfabHandle;
+    transform: TransformHandle;
+    layer: LayerHandle;
+    configuratorItems: ConfiguratorItemsHandle;
+    configuratorObjects: ConfiguratorObjectsHandle;
+}
+declare function createConfiguratorSDK(config: ConfiguratorServiceSDKConfig): ConfiguratorSDKHandle;
+declare const ConfiguratorSDK: {
+    /**
+     * Create a new SDK client instance.
+     * @param config  SDK configuration — apiKey is required, timeout is optional.
+     */
+    readonly create: (config: ConfiguratorServiceSDKConfig) => ConfiguratorSDKHandle;
+};
+
+export { type AlliumError, type ConfiguratorSDKHandle, type ConfiguratorServiceSDKConfig, type CreateConfiguratorItemInput, type CreateConfiguratorObjectInput, type CreateLinkInput, type CreateSketchfabObjectInput, type CreateStreamInput, type CreateVideoInput, type DeleteAllLayerItemsInput, type DeleteLayerItemInput, type LockLayerItemInput, type RenameLayerItemInput, type SnapToGroundInput, type UpdateConfiguratorItemStateInput, type UpdateConfiguratorObjectConfigInput, type UpdateLinkInput, type UpdatePositionInput, type UpdateRotationInput, type UpdateScaleInput, type UpdateSketchfabObjectInput, type UpdateStreamInput, type UpdateVideoInput, createConfiguratorSDK, ConfiguratorSDK as default, isAlliumError };