@omnidotdev/rdk 0.1.0 → 0.2.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.
- package/build/engine/XR.d.ts +15 -0
- package/build/engine/XR.d.ts.map +1 -0
- package/build/engine/XRSessionProvider.d.ts +8 -8
- package/build/engine/XRSessionProvider.d.ts.map +1 -1
- package/build/engine/index.d.ts +1 -1
- package/build/engine/index.d.ts.map +1 -1
- package/build/fiducial/FiducialAnchor.d.ts +0 -2
- package/build/fiducial/FiducialAnchor.d.ts.map +1 -1
- package/build/fiducial/FiducialSession.d.ts +16 -0
- package/build/fiducial/FiducialSession.d.ts.map +1 -0
- package/build/fiducial/fiducialBackend.d.ts +1 -1
- package/build/fiducial/fiducialBackend.d.ts.map +1 -1
- package/build/fiducial/index.d.ts +3 -0
- package/build/fiducial/index.d.ts.map +1 -1
- package/build/geolocation/GeolocationAnchor.d.ts +27 -0
- package/build/geolocation/GeolocationAnchor.d.ts.map +1 -0
- package/build/geolocation/GeolocationSession.d.ts +16 -0
- package/build/geolocation/GeolocationSession.d.ts.map +1 -0
- package/build/geolocation/geolocationBackend.d.ts +18 -0
- package/build/geolocation/geolocationBackend.d.ts.map +1 -0
- package/build/geolocation/index.d.ts +6 -0
- package/build/geolocation/index.d.ts.map +1 -0
- package/build/index.cjs +25 -25
- package/build/index.d.ts +2 -1
- package/build/index.d.ts.map +1 -1
- package/build/index.js +3655 -3068
- package/build/lib/types/xr/XRBackend.interface.d.ts +1 -1
- package/build/lib/types/xr/XRBackend.interface.d.ts.map +1 -1
- package/build/lib/types/xr/XRContextValue.interface.d.ts +13 -8
- package/build/lib/types/xr/XRContextValue.interface.d.ts.map +1 -1
- package/build/lib/types/xr/index.d.ts +0 -2
- package/build/lib/types/xr/index.d.ts.map +1 -1
- package/package.json +3 -1
- package/build/engine/XRCanvas.d.ts +0 -14
- package/build/engine/XRCanvas.d.ts.map +0 -1
- package/build/lib/types/xr/XRMode.type.d.ts +0 -5
- package/build/lib/types/xr/XRMode.type.d.ts.map +0 -1
- package/build/lib/types/xr/XRSessionOptions.type.d.ts +0 -14
- package/build/lib/types/xr/XRSessionOptions.type.d.ts.map +0 -1
- package/build/lib/types/xr/XRUtils.type.d.ts +0 -62
- package/build/lib/types/xr/XRUtils.type.d.ts.map +0 -1
|
@@ -14,7 +14,7 @@ export interface XRBackend {
|
|
|
14
14
|
* Update the XR backend on each frame.
|
|
15
15
|
* @param dt delta time since last frame in seconds
|
|
16
16
|
*/
|
|
17
|
-
update?(dt
|
|
17
|
+
update?(dt?: number): void;
|
|
18
18
|
/**
|
|
19
19
|
* Clean up resources when the backend is no longer needed.
|
|
20
20
|
*/
|
|
@@ -1 +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;
|
|
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,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,IAAI,IAAI,CAAC;IAEjB;;;OAGG;IACH,WAAW,CAAC,IAAI,OAAO,CAAC;CACxB"}
|
|
@@ -1,15 +1,20 @@
|
|
|
1
1
|
import { XRBackend } from './XRBackend.interface';
|
|
2
|
-
import { XRMode } from './XRMode.type';
|
|
3
2
|
/**
|
|
4
3
|
* Context value provided by XRSessionProvider.
|
|
5
|
-
*
|
|
4
|
+
* Supports session-based architecture with shared camera/video resources.
|
|
6
5
|
*/
|
|
7
6
|
export interface XRContextValue {
|
|
8
|
-
/**
|
|
9
|
-
|
|
10
|
-
/**
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
|
|
7
|
+
/** Whether the XR system is ready. */
|
|
8
|
+
isReady: boolean;
|
|
9
|
+
/** Camera source type; video uses shared `getUserMedia`, `webxr` reserved for future `@react-three/xr` */
|
|
10
|
+
camera: "video" | "webxr";
|
|
11
|
+
/** Shared video element when using video camera source. */
|
|
12
|
+
video?: HTMLVideoElement | null;
|
|
13
|
+
/** Active XR backends registered by sessions. */
|
|
14
|
+
backends: XRBackend[];
|
|
15
|
+
/** Register a backend (called by sessions). */
|
|
16
|
+
registerBackend: (backend: XRBackend, sessionType?: string) => void;
|
|
17
|
+
/** Unregister a backend (called by sessions). */
|
|
18
|
+
unregisterBackend: (backend: XRBackend, sessionType?: string) => void;
|
|
14
19
|
}
|
|
15
20
|
//# sourceMappingURL=XRContextValue.interface.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"XRContextValue.interface.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/xr/XRContextValue.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"XRContextValue.interface.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/xr/XRContextValue.interface.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B,sCAAsC;IACtC,OAAO,EAAE,OAAO,CAAC;IACjB,0GAA0G;IAC1G,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC;IAC1B,2DAA2D;IAC3D,KAAK,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAChC,iDAAiD;IACjD,QAAQ,EAAE,SAAS,EAAE,CAAC;IACtB,+CAA+C;IAC/C,eAAe,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACpE,iDAAiD;IACjD,iBAAiB,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;CACtE;AAED,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC"}
|
|
@@ -1,6 +1,4 @@
|
|
|
1
1
|
export type { XRBackend } from './XRBackend.interface';
|
|
2
2
|
export type { XRBackendInitArgs } from './XRBackendInitArgs.interface';
|
|
3
3
|
export type { XRContextValue } from './XRContextValue.interface';
|
|
4
|
-
export type { XRMode } from './XRMode.type';
|
|
5
|
-
export type { XRSessionOptions, XRSessionOptionsMap, } from './XRSessionOptions.type';
|
|
6
4
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +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
|
|
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"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@omnidotdev/rdk",
|
|
3
3
|
"description": "AR.js with react-three-fiber",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.2.0",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"main": "build/index.js",
|
|
@@ -46,6 +46,7 @@
|
|
|
46
46
|
"peerDependencies": {
|
|
47
47
|
"@ar-js-org/ar.js": "^3.4.7",
|
|
48
48
|
"@react-three/fiber": "^9.4.0",
|
|
49
|
+
"locar": "0.1.1",
|
|
49
50
|
"react": "^19.2.0",
|
|
50
51
|
"react-dom": "^19.2.0",
|
|
51
52
|
"three": "^0.180.0"
|
|
@@ -61,6 +62,7 @@
|
|
|
61
62
|
"@types/react-dom": "^19.2.2",
|
|
62
63
|
"@types/three": "^0.180.0",
|
|
63
64
|
"jsdom": "^27.0.1",
|
|
65
|
+
"locar": "^0.1.1",
|
|
64
66
|
"react": "^19.2.0",
|
|
65
67
|
"react-dom": "^19.2.0",
|
|
66
68
|
"three": "^0.180.0",
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import { CanvasProps } from '@react-three/fiber';
|
|
2
|
-
import { XRMode, XRSessionOptions } from 'lib/types/xr';
|
|
3
|
-
export interface XRCanvasProps<TMode extends XRMode = "fiducial"> extends CanvasProps {
|
|
4
|
-
/** Mode of extended reality. */
|
|
5
|
-
mode?: TMode;
|
|
6
|
-
/** Session options, forwarded to the corresponding backend. */
|
|
7
|
-
sessionOptions?: XRSessionOptions<TMode>;
|
|
8
|
-
}
|
|
9
|
-
/**
|
|
10
|
-
* Main extended reality canvas that initializes the context. This behaves as a scene root for end users.
|
|
11
|
-
*/
|
|
12
|
-
declare const XRCanvas: <TMode extends XRMode = "fiducial">({ mode, sessionOptions, children, ...rest }: XRCanvasProps<TMode>) => import("react/jsx-runtime").JSX.Element;
|
|
13
|
-
export default XRCanvas;
|
|
14
|
-
//# sourceMappingURL=XRCanvas.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"XRCanvas.d.ts","sourceRoot":"","sources":["../../src/engine/XRCanvas.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAE7D,MAAM,WAAW,aAAa,CAAC,KAAK,SAAS,MAAM,GAAG,UAAU,CAC/D,SAAQ,WAAW;IACnB,gCAAgC;IAChC,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,+DAA+D;IAC/D,cAAc,CAAC,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC;CACzC;AAED;;GAEG;AACH,QAAA,MAAM,QAAQ,GAAI,KAAK,SAAS,MAAM,GAAG,UAAU,EAAE,6CAKlD,aAAa,CAAC,KAAK,CAAC,4CAMtB,CAAC;AAEF,eAAe,QAAQ,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
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"}
|
|
@@ -1,14 +0,0 @@
|
|
|
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
|
|
@@ -1 +0,0 @@
|
|
|
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"}
|
|
@@ -1,62 +0,0 @@
|
|
|
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
|
|
@@ -1 +0,0 @@
|
|
|
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"}
|