@omnidotdev/rdk 0.1.0

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.
Files changed (31) hide show
  1. package/build/engine/XRCanvas.d.ts +14 -0
  2. package/build/engine/XRCanvas.d.ts.map +1 -0
  3. package/build/engine/XRSessionProvider.d.ts +18 -0
  4. package/build/engine/XRSessionProvider.d.ts.map +1 -0
  5. package/build/engine/index.d.ts +2 -0
  6. package/build/engine/index.d.ts.map +1 -0
  7. package/build/fiducial/FiducialAnchor.d.ts +21 -0
  8. package/build/fiducial/FiducialAnchor.d.ts.map +1 -0
  9. package/build/fiducial/fiducialBackend.d.ts +19 -0
  10. package/build/fiducial/fiducialBackend.d.ts.map +1 -0
  11. package/build/fiducial/index.d.ts +3 -0
  12. package/build/fiducial/index.d.ts.map +1 -0
  13. package/build/index.cjs +51 -0
  14. package/build/index.d.ts +4 -0
  15. package/build/index.d.ts.map +1 -0
  16. package/build/index.js +5412 -0
  17. package/build/lib/types/xr/XRBackend.interface.d.ts +28 -0
  18. package/build/lib/types/xr/XRBackend.interface.d.ts.map +1 -0
  19. package/build/lib/types/xr/XRBackendInitArgs.interface.d.ts +14 -0
  20. package/build/lib/types/xr/XRBackendInitArgs.interface.d.ts.map +1 -0
  21. package/build/lib/types/xr/XRContextValue.interface.d.ts +15 -0
  22. package/build/lib/types/xr/XRContextValue.interface.d.ts.map +1 -0
  23. package/build/lib/types/xr/XRMode.type.d.ts +5 -0
  24. package/build/lib/types/xr/XRMode.type.d.ts.map +1 -0
  25. package/build/lib/types/xr/XRSessionOptions.type.d.ts +14 -0
  26. package/build/lib/types/xr/XRSessionOptions.type.d.ts.map +1 -0
  27. package/build/lib/types/xr/XRUtils.type.d.ts +62 -0
  28. package/build/lib/types/xr/XRUtils.type.d.ts.map +1 -0
  29. package/build/lib/types/xr/index.d.ts +6 -0
  30. package/build/lib/types/xr/index.d.ts.map +1 -0
  31. package/package.json +74 -0
@@ -0,0 +1,28 @@
1
+ import { XRBackendInitArgs } from './XRBackendInitArgs.interface';
2
+ /**
3
+ * Extended reality backend interface.
4
+ * Defines the contract for XR backend implementations (fiducial, geolocation, WebXR, etc.).
5
+ */
6
+ export interface XRBackend {
7
+ /**
8
+ * Initialize the XR backend with the provided arguments.
9
+ * @param args initialization arguments containing scene, camera, and renderer
10
+ * @returns promise that resolves when initialization is complete, or void for synchronous init
11
+ */
12
+ init(args: XRBackendInitArgs): Promise<void> | void;
13
+ /**
14
+ * Update the XR backend on each frame.
15
+ * @param dt delta time since last frame in seconds
16
+ */
17
+ update?(dt: number): void;
18
+ /**
19
+ * Clean up resources when the backend is no longer needed.
20
+ */
21
+ dispose?(): void;
22
+ /**
23
+ * Get internal SDK objects for advanced use cases.
24
+ * @returns internal objects specific to the backend implementation
25
+ */
26
+ getInternal?(): unknown;
27
+ }
28
+ //# sourceMappingURL=XRBackend.interface.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"XRBackend.interface.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/xr/XRBackend.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAElE;;;GAGG;AACH,MAAM,WAAW,SAAS;IACzB;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAEpD;;;OAGG;IACH,MAAM,CAAC,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,IAAI,IAAI,CAAC;IAEjB;;;OAGG;IACH,WAAW,CAAC,IAAI,OAAO,CAAC;CACxB"}
@@ -0,0 +1,14 @@
1
+ import type * as THREE from "three";
2
+ /**
3
+ * Initialization arguments for XR backends.
4
+ * Contains the Three.js objects required to initialize any XR backend.
5
+ */
6
+ export interface XRBackendInitArgs {
7
+ /** The Three.js scene to render XR content into. */
8
+ scene: THREE.Scene;
9
+ /** The Three.js camera used for rendering. */
10
+ camera: THREE.Camera;
11
+ /** The WebGL renderer instance. */
12
+ renderer: THREE.WebGLRenderer;
13
+ }
14
+ //# sourceMappingURL=XRBackendInitArgs.interface.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"XRBackendInitArgs.interface.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/xr/XRBackendInitArgs.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,KAAK,MAAM,OAAO,CAAC;AAEpC;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IACjC,oDAAoD;IACpD,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC;IACnB,8CAA8C;IAC9C,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;IACrB,mCAAmC;IACnC,QAAQ,EAAE,KAAK,CAAC,aAAa,CAAC;CAC9B"}
@@ -0,0 +1,15 @@
1
+ import { XRBackend } from './XRBackend.interface';
2
+ import { XRMode } from './XRMode.type';
3
+ /**
4
+ * Context value provided by XRSessionProvider.
5
+ * Contains the current XR session state and backend instance.
6
+ */
7
+ export interface XRContextValue {
8
+ /** Current XR mode. */
9
+ mode: XRMode;
10
+ /** Whether the XR backend is fully initialized and ready. */
11
+ ready: boolean;
12
+ /** The active XR backend instance, null if not initialized. */
13
+ backend: XRBackend | null;
14
+ }
15
+ //# sourceMappingURL=XRContextValue.interface.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"XRContextValue.interface.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/xr/XRContextValue.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEvC;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,6DAA6D;IAC7D,KAAK,EAAE,OAAO,CAAC;IACf,+DAA+D;IAC/D,OAAO,EAAE,SAAS,GAAG,IAAI,CAAC;CAC1B"}
@@ -0,0 +1,5 @@
1
+ /**
2
+ * Mode of extended reality.
3
+ */
4
+ export type XRMode = "fiducial";
5
+ //# sourceMappingURL=XRMode.type.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"XRMode.type.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/xr/XRMode.type.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC"}
@@ -0,0 +1,14 @@
1
+ import { FiducialSessionOptions } from '../../../fiducial';
2
+ /**
3
+ * Session options mapping for different XR modes.
4
+ * This provides type-safe options based on the selected XR mode.
5
+ */
6
+ export interface XRSessionOptionsMap {
7
+ fiducial: FiducialSessionOptions;
8
+ }
9
+ /**
10
+ * Get session options type for a specific XR mode.
11
+ * This enables generic narrowing for type-safe session options.
12
+ */
13
+ export type XRSessionOptions<T extends keyof XRSessionOptionsMap> = XRSessionOptionsMap[T];
14
+ //# sourceMappingURL=XRSessionOptions.type.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"XRSessionOptions.type.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/xr/XRSessionOptions.type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAEhE;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,QAAQ,EAAE,sBAAsB,CAAC;CAKjC;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,MAAM,mBAAmB,IAC/D,mBAAmB,CAAC,CAAC,CAAC,CAAC"}
@@ -0,0 +1,62 @@
1
+ import { XRMode, XRSessionOptions } from './index';
2
+ /**
3
+ * Utility type to infer XR mode from session options.
4
+ * This helps TypeScript understand the relationship between mode and options.
5
+ */
6
+ export type InferXRMode<T> = T extends XRSessionOptions<infer M> ? M : never;
7
+ /**
8
+ * Utility type to create a typed XR configuration.
9
+ * This ensures mode and sessionOptions are compatible.
10
+ */
11
+ export type XRConfig<TMode extends XRMode> = {
12
+ /** XR mode to use. */
13
+ mode: TMode;
14
+ /** XR session options for the specified mode. */
15
+ sessionOptions?: XRSessionOptions<TMode>;
16
+ };
17
+ /**
18
+ * Create a typed XR configuration with full type safety.
19
+ *
20
+ * @example
21
+ * ```typescript
22
+ * const config = createXRConfig({
23
+ * mode: "fiducial",
24
+ * sessionOptions: {
25
+ * sourceType: "webcam",
26
+ * patternRatio: 0.8
27
+ * }
28
+ * });
29
+ * ```
30
+ */
31
+ export declare const createXRConfig: <TMode extends XRMode>(config: XRConfig<TMode>) => XRConfig<TMode>;
32
+ /**
33
+ * Type guard to check if session options match a specific XR mode.
34
+ * Useful for runtime type checking and narrowing.
35
+ */
36
+ export declare const isXRMode: <TMode extends XRMode>(mode: XRMode, targetMode: TMode) => mode is TMode;
37
+ /**
38
+ * Utility type for XR component props that need mode-specific session options.
39
+ */
40
+ export type XRComponentProps<TMode extends XRMode = XRMode> = {
41
+ /** XR mode to use. */
42
+ mode?: TMode;
43
+ /** XR session options for the specified mode. */
44
+ sessionOptions?: XRSessionOptions<TMode>;
45
+ };
46
+ /**
47
+ * Default session options for each XR mode.
48
+ * Provides sensible defaults while maintaining type safety.
49
+ */
50
+ export declare const DEFAULT_XR_SESSION_OPTIONS: {
51
+ readonly fiducial: {
52
+ readonly sourceType: "webcam";
53
+ readonly detectionMode: "mono";
54
+ readonly patternRatio: 0.5;
55
+ readonly matrixCodeType: "3x3";
56
+ };
57
+ };
58
+ /**
59
+ * Get default session options for a specific XR mode.
60
+ */
61
+ export declare const getDefaultSessionOptions: <TMode extends XRMode>(mode: TMode) => XRSessionOptions<TMode>;
62
+ //# sourceMappingURL=XRUtils.type.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"XRUtils.type.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/xr/XRUtils.type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAExD;;;GAGG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,gBAAgB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAE7E;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,KAAK,SAAS,MAAM,IAAI;IAC5C,sBAAsB;IACtB,IAAI,EAAE,KAAK,CAAC;IACZ,iDAAiD;IACjD,cAAc,CAAC,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC;CACzC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,cAAc,GAAI,KAAK,SAAS,MAAM,EAClD,QAAQ,QAAQ,CAAC,KAAK,CAAC,KACrB,QAAQ,CAAC,KAAK,CAAW,CAAC;AAE7B;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,KAAK,SAAS,MAAM,EAC5C,MAAM,MAAM,EACZ,YAAY,KAAK,KACf,IAAI,IAAI,KAA4B,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,KAAK,SAAS,MAAM,GAAG,MAAM,IAAI;IAC7D,sBAAsB;IACtB,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,iDAAiD;IACjD,cAAc,CAAC,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC;CACzC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,0BAA0B;;;;;;;CAWsB,CAAC;AAE9D;;GAEG;AACH,eAAO,MAAM,wBAAwB,GAAI,KAAK,SAAS,MAAM,EAC5D,MAAM,KAAK,KACT,gBAAgB,CAAC,KAAK,CACmC,CAAC"}
@@ -0,0 +1,6 @@
1
+ export type { XRBackend } from './XRBackend.interface';
2
+ export type { XRBackendInitArgs } from './XRBackendInitArgs.interface';
3
+ export type { XRContextValue } from './XRContextValue.interface';
4
+ export type { XRMode } from './XRMode.type';
5
+ export type { XRSessionOptions, XRSessionOptionsMap, } from './XRSessionOptions.type';
6
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/xr/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACvD,YAAY,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACvE,YAAY,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACjE,YAAY,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAC5C,YAAY,EACX,gBAAgB,EAChB,mBAAmB,GACnB,MAAM,yBAAyB,CAAC"}
package/package.json ADDED
@@ -0,0 +1,74 @@
1
+ {
2
+ "name": "@omnidotdev/rdk",
3
+ "description": "AR.js with react-three-fiber",
4
+ "version": "0.1.0",
5
+ "license": "MIT",
6
+ "type": "module",
7
+ "main": "build/index.js",
8
+ "module": "build/index.js",
9
+ "types": "build/index.d.ts",
10
+ "homepage": "https://github.com/omnidotdev/rdk#readme",
11
+ "repository": {
12
+ "type": "git",
13
+ "url": "git+https://github.com/omnidotdev/rdk.git"
14
+ },
15
+ "bugs": {
16
+ "url": "https://github.com/omnidotdev/rdk/issues"
17
+ },
18
+ "files": [
19
+ "build/"
20
+ ],
21
+ "keywords": [
22
+ "react",
23
+ "react-three-fiber",
24
+ "ar.js",
25
+ "ar",
26
+ "three",
27
+ "typescript"
28
+ ],
29
+ "exports": {
30
+ ".": {
31
+ "types": "./build/index.d.ts",
32
+ "import": "./build/index.js",
33
+ "require": "./build/index.cjs"
34
+ }
35
+ },
36
+ "scripts": {
37
+ "build": "vite build",
38
+ "clean": "rm -rf build",
39
+ "dev": "vite build --watch --mode development",
40
+ "format": "biome format --write .",
41
+ "lint": "biome check .",
42
+ "lint:fix": "biome check --write .",
43
+ "test": "vitest",
44
+ "release": "bun run build && changeset publish"
45
+ },
46
+ "peerDependencies": {
47
+ "@ar-js-org/ar.js": "^3.4.7",
48
+ "@react-three/fiber": "^9.4.0",
49
+ "react": "^19.2.0",
50
+ "react-dom": "^19.2.0",
51
+ "three": "^0.180.0"
52
+ },
53
+ "devDependencies": {
54
+ "@ar-js-org/ar.js": "^3.4.7",
55
+ "@biomejs/biome": "^2.3.2",
56
+ "@react-three/fiber": "^9.4.0",
57
+ "@testing-library/jest-dom": "^6.9.1",
58
+ "@testing-library/react": "^16.3.0",
59
+ "@types/node": "^24.9.2",
60
+ "@types/react": "^19.2.2",
61
+ "@types/react-dom": "^19.2.2",
62
+ "@types/three": "^0.180.0",
63
+ "jsdom": "^27.0.1",
64
+ "react": "^19.2.0",
65
+ "react-dom": "^19.2.0",
66
+ "three": "^0.180.0",
67
+ "ts-pattern": "^5.9.0",
68
+ "typescript": "^5.9.3",
69
+ "vite": "^7.1.12",
70
+ "vite-plugin-dts": "^4.5.4",
71
+ "vite-tsconfig-paths": "^5.1.4",
72
+ "vitest": "^4.0.5"
73
+ }
74
+ }