@asiyst/sdk 0.1.21 → 0.1.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -1,3 +1,5 @@
1
+ import * as THREE from 'three';
2
+
1
3
  interface AsiystEventMap {
2
4
  "asiyst:initialized": {
3
5
  projectId: string;
@@ -19,6 +21,26 @@ interface AsiystEventMap {
19
21
  x: number;
20
22
  y: number;
21
23
  };
24
+ "asiyst:avatar:loading": {
25
+ avatarId?: string;
26
+ assetUrl?: string;
27
+ };
28
+ "asiyst:avatar:loaded": {
29
+ avatarId?: string;
30
+ assetUrl?: string;
31
+ format?: string;
32
+ };
33
+ "asiyst:avatar:rendered": {
34
+ avatarId?: string;
35
+ format?: string;
36
+ durationMs?: number;
37
+ };
38
+ "asiyst:avatar:error": {
39
+ avatarId?: string;
40
+ error: string;
41
+ code?: string;
42
+ stage?: string;
43
+ };
22
44
  "asiyst:target:found": {
23
45
  target: TargetRef;
24
46
  elementId: string;
@@ -60,6 +82,17 @@ interface AsiystEventMap {
60
82
  "asiyst:conversation:closed": {
61
83
  conversationId: string;
62
84
  };
85
+ "asiyst:runtime:connected": {
86
+ projectId: string;
87
+ status: "connected" | "verified";
88
+ environment?: string;
89
+ origin?: string;
90
+ };
91
+ "asiyst:runtime:disconnected": {
92
+ projectId: string;
93
+ reason: string;
94
+ status?: string;
95
+ };
63
96
  "asiyst:error": {
64
97
  code: string;
65
98
  message: string;
@@ -85,6 +118,7 @@ interface InitOptions {
85
118
  avatarId?: string;
86
119
  position?: AnchorPosition;
87
120
  apiBaseUrl?: string;
121
+ environment?: "production" | "development" | "preview";
88
122
  mode?: AssistantMode;
89
123
  allowedActions?: ActionKind[];
90
124
  observeHistory?: boolean;
@@ -127,11 +161,29 @@ interface AvatarDataSource {
127
161
  headers?: Record<string, string>;
128
162
  credentials?: string;
129
163
  }
164
+ interface AvatarAnimation {
165
+ id?: string;
166
+ name: string;
167
+ intent?: string;
168
+ clipName?: string;
169
+ loopMode?: string;
170
+ durationMs?: number;
171
+ assetUrl?: string | null;
172
+ }
173
+ interface AvatarBranding {
174
+ siteLogoUrl?: string | null;
175
+ }
130
176
  interface ProjectConfig {
131
177
  schemaVersion: number;
132
178
  version: number;
133
179
  avatarName: string;
134
180
  avatar: string;
181
+ avatarId?: string;
182
+ assetUrl?: string;
183
+ thumbnailUrl?: string | null;
184
+ publishedVersion?: string;
185
+ animations?: AvatarAnimation[];
186
+ branding?: AvatarBranding;
135
187
  size: number;
136
188
  position: AnchorPosition;
137
189
  voice?: string;
@@ -219,6 +271,7 @@ declare const Asiyst: {
219
271
  getConfig(): ProjectConfig;
220
272
  getConnectionStatus(): "connected" | "disconnected" | "offline";
221
273
  getVerificationStatus(): "connected" | "inactive" | "not_detected" | "error";
274
+ isRuntimeConnected(): boolean;
222
275
  avatar: {
223
276
  show(): void;
224
277
  hide(): void;
@@ -348,4 +401,166 @@ declare function evaluateActionPermission(action: ActionKind, config: ProjectCon
348
401
  };
349
402
  declare function isActionAllowed(action: ActionKind, config: ProjectConfig, source: "developer" | "cloud" | "local", currentUrl?: string, target?: string): boolean;
350
403
 
351
- export { type ActionKind, ActionNotAllowedError, Asiyst, AsiystError, type AsiystEventMap, type AsiystEventName, type AssistantMode, AuthenticationError, ConfigurationError, type HighlightStyle, type InitOptions, InitializationError, type MappedElement, NetworkError, type ProjectConfig, SDK_VERSION, type TargetInput, TargetNotFoundError, type TargetRef, type TaskDefinition, TaskExecutionError, TaskStatus, type TaskStep, type WebsiteMapSnapshot, type WorkflowDefinition, anchorToViewport, canNavigateTo, canTransition, computeAvatarDestination, evaluateActionPermission, fallbackConfig, isActionAllowed, isSafeSelector, normalizeProjectConfig, sanitizeText, validateInitOptions, validateWebsiteDomain };
404
+ interface ParsedGlbMesh {
405
+ name?: string;
406
+ positions: Float32Array;
407
+ normals?: Float32Array;
408
+ indices?: Uint16Array | Uint32Array;
409
+ }
410
+ interface LoadedGlbAsset {
411
+ format: "glb";
412
+ url: string;
413
+ json: Record<string, unknown>;
414
+ bin: Uint8Array;
415
+ meshes: ParsedGlbMesh[];
416
+ embeddedImageUrls: string[];
417
+ durationMs: number;
418
+ }
419
+ interface LoadedImageAsset {
420
+ format: "image";
421
+ url: string;
422
+ image?: HTMLImageElement;
423
+ width?: number;
424
+ height?: number;
425
+ durationMs: number;
426
+ }
427
+ interface LoadedManifestAsset {
428
+ format: "manifest";
429
+ url: string;
430
+ manifest: Record<string, unknown>;
431
+ durationMs: number;
432
+ }
433
+ interface LoadedFbxAsset {
434
+ format: "fbx";
435
+ url: string;
436
+ buffer: ArrayBuffer;
437
+ version?: number;
438
+ isBinary: boolean;
439
+ resourcePath: string;
440
+ durationMs: number;
441
+ }
442
+ type LoadedAvatarAsset = LoadedFbxAsset | LoadedGlbAsset | LoadedImageAsset | LoadedManifestAsset;
443
+ declare class AssetLoader {
444
+ private inFlightController;
445
+ private readonly createdObjectUrls;
446
+ load(assetUrl: string, options?: {
447
+ signal?: AbortSignal;
448
+ timeoutMs?: number;
449
+ }): Promise<LoadedAvatarAsset>;
450
+ isFbxBuffer(buffer: ArrayBuffer): boolean;
451
+ parseFbxHeader(buffer: ArrayBuffer): {
452
+ isBinary: boolean;
453
+ version?: number;
454
+ };
455
+ isGlbBuffer(buffer: ArrayBuffer): boolean;
456
+ private loadImage;
457
+ parseGlb(buffer: ArrayBuffer): {
458
+ json: Record<string, unknown>;
459
+ bin: Uint8Array;
460
+ meshes: ParsedGlbMesh[];
461
+ embeddedImageUrls: string[];
462
+ };
463
+ destroy(): void;
464
+ }
465
+
466
+ type AvatarPose = "idle" | "point" | "think" | "celebrate" | "speak" | "walk";
467
+ interface AvatarRenderer {
468
+ mount(container: HTMLElement, config: ProjectConfig): void;
469
+ unmount(): void;
470
+ applyConfig(config: ProjectConfig): void;
471
+ setPosition(x: number, y: number, animate: boolean): void;
472
+ setFacing(direction: "left" | "right"): void;
473
+ setPose(pose: AvatarPose): void;
474
+ setSpeech(text: string | null): void;
475
+ getSize(): {
476
+ width: number;
477
+ height: number;
478
+ };
479
+ }
480
+
481
+ interface FbxRenderMetrics {
482
+ meshCount: number;
483
+ vertexCount: number;
484
+ animationCount: number;
485
+ }
486
+ declare class FbxRenderer {
487
+ private canvas;
488
+ private renderer;
489
+ private scene;
490
+ private camera;
491
+ private modelRoot;
492
+ private mixer;
493
+ private animFrameId;
494
+ private lastTime;
495
+ private facing;
496
+ private currentPose;
497
+ private initialRenderCompleted;
498
+ mount(container: HTMLElement, asset: LoadedFbxAsset | LoadedGlbAsset, options?: {
499
+ accentColor?: string;
500
+ config?: ProjectConfig;
501
+ }): Promise<FbxRenderMetrics>;
502
+ setFacing(direction: "left" | "right"): void;
503
+ setPose(pose: AvatarPose): void;
504
+ isRendered(): boolean;
505
+ validateGeometry(rawObject: THREE.Object3D): {
506
+ meshCount: number;
507
+ vertexCount: number;
508
+ };
509
+ getCanvas(): HTMLCanvasElement | null;
510
+ private startLoop;
511
+ destroy(): void;
512
+ }
513
+
514
+ type AvatarRenderState = "idle" | "loading" | "ready" | "error";
515
+ declare class CssAvatarRenderer implements AvatarRenderer {
516
+ private root;
517
+ private figure;
518
+ private viewport;
519
+ private bubble;
520
+ private nameEl;
521
+ private size;
522
+ private hidden;
523
+ private facing;
524
+ private pose;
525
+ private accentColor;
526
+ private avatarName;
527
+ private readonly assetLoader;
528
+ private fbxRenderer;
529
+ private renderState;
530
+ private isAssetLoadedFlag;
531
+ private isFallbackFlag;
532
+ private loadedFormat;
533
+ private activeAssetUrl;
534
+ private lastErrorMessage;
535
+ private renderMetrics;
536
+ mount(container: HTMLElement, config: ProjectConfig): void;
537
+ unmount(): void;
538
+ applyConfig(config: ProjectConfig): void;
539
+ loadAsset(config: ProjectConfig): Promise<boolean>;
540
+ private renderLoader;
541
+ private renderLoadedAsset;
542
+ private renderFallback;
543
+ setPosition(x: number, y: number, animate: boolean): void;
544
+ setFacing(direction: "left" | "right"): void;
545
+ setPose(pose: AvatarPose): void;
546
+ private syncTransform;
547
+ setSpeech(text: string | null): void;
548
+ getSize(): {
549
+ width: number;
550
+ height: number;
551
+ };
552
+ setHidden(hidden: boolean): void;
553
+ isHidden(): boolean;
554
+ getFigure(): HTMLElement | undefined;
555
+ getViewport(): HTMLElement | undefined;
556
+ isAssetLoaded(): boolean;
557
+ isRendered(): boolean;
558
+ isFallbackActive(): boolean;
559
+ getRenderState(): AvatarRenderState;
560
+ getLoadedFormat(): string | undefined;
561
+ getAssetUrl(): string | undefined;
562
+ getLastError(): string | undefined;
563
+ getMetrics(): FbxRenderMetrics | undefined;
564
+ }
565
+
566
+ export { type ActionKind, ActionNotAllowedError, Asiyst, AsiystError, type AsiystEventMap, type AsiystEventName, AssetLoader, type AssistantMode, AuthenticationError, type AvatarAnimation, type AvatarBranding, ConfigurationError, CssAvatarRenderer, FbxRenderer, type HighlightStyle, type InitOptions, InitializationError, type MappedElement, NetworkError, type ProjectConfig, SDK_VERSION, type TargetInput, TargetNotFoundError, type TargetRef, type TaskDefinition, TaskExecutionError, TaskStatus, type TaskStep, type WebsiteMapSnapshot, type WorkflowDefinition, anchorToViewport, canNavigateTo, canTransition, computeAvatarDestination, evaluateActionPermission, fallbackConfig, isActionAllowed, isSafeSelector, normalizeProjectConfig, sanitizeText, validateInitOptions, validateWebsiteDomain };
package/dist/index.d.ts CHANGED
@@ -1,3 +1,5 @@
1
+ import * as THREE from 'three';
2
+
1
3
  interface AsiystEventMap {
2
4
  "asiyst:initialized": {
3
5
  projectId: string;
@@ -19,6 +21,26 @@ interface AsiystEventMap {
19
21
  x: number;
20
22
  y: number;
21
23
  };
24
+ "asiyst:avatar:loading": {
25
+ avatarId?: string;
26
+ assetUrl?: string;
27
+ };
28
+ "asiyst:avatar:loaded": {
29
+ avatarId?: string;
30
+ assetUrl?: string;
31
+ format?: string;
32
+ };
33
+ "asiyst:avatar:rendered": {
34
+ avatarId?: string;
35
+ format?: string;
36
+ durationMs?: number;
37
+ };
38
+ "asiyst:avatar:error": {
39
+ avatarId?: string;
40
+ error: string;
41
+ code?: string;
42
+ stage?: string;
43
+ };
22
44
  "asiyst:target:found": {
23
45
  target: TargetRef;
24
46
  elementId: string;
@@ -60,6 +82,17 @@ interface AsiystEventMap {
60
82
  "asiyst:conversation:closed": {
61
83
  conversationId: string;
62
84
  };
85
+ "asiyst:runtime:connected": {
86
+ projectId: string;
87
+ status: "connected" | "verified";
88
+ environment?: string;
89
+ origin?: string;
90
+ };
91
+ "asiyst:runtime:disconnected": {
92
+ projectId: string;
93
+ reason: string;
94
+ status?: string;
95
+ };
63
96
  "asiyst:error": {
64
97
  code: string;
65
98
  message: string;
@@ -85,6 +118,7 @@ interface InitOptions {
85
118
  avatarId?: string;
86
119
  position?: AnchorPosition;
87
120
  apiBaseUrl?: string;
121
+ environment?: "production" | "development" | "preview";
88
122
  mode?: AssistantMode;
89
123
  allowedActions?: ActionKind[];
90
124
  observeHistory?: boolean;
@@ -127,11 +161,29 @@ interface AvatarDataSource {
127
161
  headers?: Record<string, string>;
128
162
  credentials?: string;
129
163
  }
164
+ interface AvatarAnimation {
165
+ id?: string;
166
+ name: string;
167
+ intent?: string;
168
+ clipName?: string;
169
+ loopMode?: string;
170
+ durationMs?: number;
171
+ assetUrl?: string | null;
172
+ }
173
+ interface AvatarBranding {
174
+ siteLogoUrl?: string | null;
175
+ }
130
176
  interface ProjectConfig {
131
177
  schemaVersion: number;
132
178
  version: number;
133
179
  avatarName: string;
134
180
  avatar: string;
181
+ avatarId?: string;
182
+ assetUrl?: string;
183
+ thumbnailUrl?: string | null;
184
+ publishedVersion?: string;
185
+ animations?: AvatarAnimation[];
186
+ branding?: AvatarBranding;
135
187
  size: number;
136
188
  position: AnchorPosition;
137
189
  voice?: string;
@@ -219,6 +271,7 @@ declare const Asiyst: {
219
271
  getConfig(): ProjectConfig;
220
272
  getConnectionStatus(): "connected" | "disconnected" | "offline";
221
273
  getVerificationStatus(): "connected" | "inactive" | "not_detected" | "error";
274
+ isRuntimeConnected(): boolean;
222
275
  avatar: {
223
276
  show(): void;
224
277
  hide(): void;
@@ -348,4 +401,166 @@ declare function evaluateActionPermission(action: ActionKind, config: ProjectCon
348
401
  };
349
402
  declare function isActionAllowed(action: ActionKind, config: ProjectConfig, source: "developer" | "cloud" | "local", currentUrl?: string, target?: string): boolean;
350
403
 
351
- export { type ActionKind, ActionNotAllowedError, Asiyst, AsiystError, type AsiystEventMap, type AsiystEventName, type AssistantMode, AuthenticationError, ConfigurationError, type HighlightStyle, type InitOptions, InitializationError, type MappedElement, NetworkError, type ProjectConfig, SDK_VERSION, type TargetInput, TargetNotFoundError, type TargetRef, type TaskDefinition, TaskExecutionError, TaskStatus, type TaskStep, type WebsiteMapSnapshot, type WorkflowDefinition, anchorToViewport, canNavigateTo, canTransition, computeAvatarDestination, evaluateActionPermission, fallbackConfig, isActionAllowed, isSafeSelector, normalizeProjectConfig, sanitizeText, validateInitOptions, validateWebsiteDomain };
404
+ interface ParsedGlbMesh {
405
+ name?: string;
406
+ positions: Float32Array;
407
+ normals?: Float32Array;
408
+ indices?: Uint16Array | Uint32Array;
409
+ }
410
+ interface LoadedGlbAsset {
411
+ format: "glb";
412
+ url: string;
413
+ json: Record<string, unknown>;
414
+ bin: Uint8Array;
415
+ meshes: ParsedGlbMesh[];
416
+ embeddedImageUrls: string[];
417
+ durationMs: number;
418
+ }
419
+ interface LoadedImageAsset {
420
+ format: "image";
421
+ url: string;
422
+ image?: HTMLImageElement;
423
+ width?: number;
424
+ height?: number;
425
+ durationMs: number;
426
+ }
427
+ interface LoadedManifestAsset {
428
+ format: "manifest";
429
+ url: string;
430
+ manifest: Record<string, unknown>;
431
+ durationMs: number;
432
+ }
433
+ interface LoadedFbxAsset {
434
+ format: "fbx";
435
+ url: string;
436
+ buffer: ArrayBuffer;
437
+ version?: number;
438
+ isBinary: boolean;
439
+ resourcePath: string;
440
+ durationMs: number;
441
+ }
442
+ type LoadedAvatarAsset = LoadedFbxAsset | LoadedGlbAsset | LoadedImageAsset | LoadedManifestAsset;
443
+ declare class AssetLoader {
444
+ private inFlightController;
445
+ private readonly createdObjectUrls;
446
+ load(assetUrl: string, options?: {
447
+ signal?: AbortSignal;
448
+ timeoutMs?: number;
449
+ }): Promise<LoadedAvatarAsset>;
450
+ isFbxBuffer(buffer: ArrayBuffer): boolean;
451
+ parseFbxHeader(buffer: ArrayBuffer): {
452
+ isBinary: boolean;
453
+ version?: number;
454
+ };
455
+ isGlbBuffer(buffer: ArrayBuffer): boolean;
456
+ private loadImage;
457
+ parseGlb(buffer: ArrayBuffer): {
458
+ json: Record<string, unknown>;
459
+ bin: Uint8Array;
460
+ meshes: ParsedGlbMesh[];
461
+ embeddedImageUrls: string[];
462
+ };
463
+ destroy(): void;
464
+ }
465
+
466
+ type AvatarPose = "idle" | "point" | "think" | "celebrate" | "speak" | "walk";
467
+ interface AvatarRenderer {
468
+ mount(container: HTMLElement, config: ProjectConfig): void;
469
+ unmount(): void;
470
+ applyConfig(config: ProjectConfig): void;
471
+ setPosition(x: number, y: number, animate: boolean): void;
472
+ setFacing(direction: "left" | "right"): void;
473
+ setPose(pose: AvatarPose): void;
474
+ setSpeech(text: string | null): void;
475
+ getSize(): {
476
+ width: number;
477
+ height: number;
478
+ };
479
+ }
480
+
481
+ interface FbxRenderMetrics {
482
+ meshCount: number;
483
+ vertexCount: number;
484
+ animationCount: number;
485
+ }
486
+ declare class FbxRenderer {
487
+ private canvas;
488
+ private renderer;
489
+ private scene;
490
+ private camera;
491
+ private modelRoot;
492
+ private mixer;
493
+ private animFrameId;
494
+ private lastTime;
495
+ private facing;
496
+ private currentPose;
497
+ private initialRenderCompleted;
498
+ mount(container: HTMLElement, asset: LoadedFbxAsset | LoadedGlbAsset, options?: {
499
+ accentColor?: string;
500
+ config?: ProjectConfig;
501
+ }): Promise<FbxRenderMetrics>;
502
+ setFacing(direction: "left" | "right"): void;
503
+ setPose(pose: AvatarPose): void;
504
+ isRendered(): boolean;
505
+ validateGeometry(rawObject: THREE.Object3D): {
506
+ meshCount: number;
507
+ vertexCount: number;
508
+ };
509
+ getCanvas(): HTMLCanvasElement | null;
510
+ private startLoop;
511
+ destroy(): void;
512
+ }
513
+
514
+ type AvatarRenderState = "idle" | "loading" | "ready" | "error";
515
+ declare class CssAvatarRenderer implements AvatarRenderer {
516
+ private root;
517
+ private figure;
518
+ private viewport;
519
+ private bubble;
520
+ private nameEl;
521
+ private size;
522
+ private hidden;
523
+ private facing;
524
+ private pose;
525
+ private accentColor;
526
+ private avatarName;
527
+ private readonly assetLoader;
528
+ private fbxRenderer;
529
+ private renderState;
530
+ private isAssetLoadedFlag;
531
+ private isFallbackFlag;
532
+ private loadedFormat;
533
+ private activeAssetUrl;
534
+ private lastErrorMessage;
535
+ private renderMetrics;
536
+ mount(container: HTMLElement, config: ProjectConfig): void;
537
+ unmount(): void;
538
+ applyConfig(config: ProjectConfig): void;
539
+ loadAsset(config: ProjectConfig): Promise<boolean>;
540
+ private renderLoader;
541
+ private renderLoadedAsset;
542
+ private renderFallback;
543
+ setPosition(x: number, y: number, animate: boolean): void;
544
+ setFacing(direction: "left" | "right"): void;
545
+ setPose(pose: AvatarPose): void;
546
+ private syncTransform;
547
+ setSpeech(text: string | null): void;
548
+ getSize(): {
549
+ width: number;
550
+ height: number;
551
+ };
552
+ setHidden(hidden: boolean): void;
553
+ isHidden(): boolean;
554
+ getFigure(): HTMLElement | undefined;
555
+ getViewport(): HTMLElement | undefined;
556
+ isAssetLoaded(): boolean;
557
+ isRendered(): boolean;
558
+ isFallbackActive(): boolean;
559
+ getRenderState(): AvatarRenderState;
560
+ getLoadedFormat(): string | undefined;
561
+ getAssetUrl(): string | undefined;
562
+ getLastError(): string | undefined;
563
+ getMetrics(): FbxRenderMetrics | undefined;
564
+ }
565
+
566
+ export { type ActionKind, ActionNotAllowedError, Asiyst, AsiystError, type AsiystEventMap, type AsiystEventName, AssetLoader, type AssistantMode, AuthenticationError, type AvatarAnimation, type AvatarBranding, ConfigurationError, CssAvatarRenderer, FbxRenderer, type HighlightStyle, type InitOptions, InitializationError, type MappedElement, NetworkError, type ProjectConfig, SDK_VERSION, type TargetInput, TargetNotFoundError, type TargetRef, type TaskDefinition, TaskExecutionError, TaskStatus, type TaskStep, type WebsiteMapSnapshot, type WorkflowDefinition, anchorToViewport, canNavigateTo, canTransition, computeAvatarDestination, evaluateActionPermission, fallbackConfig, isActionAllowed, isSafeSelector, normalizeProjectConfig, sanitizeText, validateInitOptions, validateWebsiteDomain };