@tomorrowevening/theatre-core 1.0.8 → 1.0.10

package/dist/index.d.ts

@@ -1,9 +1,5 @@
-export * from './coreExports';
-export { IProject, IProjectConfig } from './projects/TheatreProject';
-export { ISequence } from './sequences/TheatreSequence';
-export { ISheetObject } from './sheetObjects/TheatreSheetObject';
-export { ISheet } from './sheets/TheatreSheet';
-export { UnknownShorthandCompoundProps } from './propTypes/index';
+import type { PointerType, Prism } from '@tomorrowevening/theatre-dataverse';
+import type { VoidFn } from '@tomorrowevening/theatre-shared/utils/types';
 import { OnDiskState } from './projects/store/storeTypes';
 
 /**
@@ -12,6 +8,92 @@ import { OnDiskState } from './projects/store/storeTypes';
  * @packageDocumentation
  */
 
+// Re-exported from coreExports
+export { notify } from '@tomorrowevening/theatre-shared/notify';
+export * as types from './propTypes/index';
+export { createRafDriver } from './rafDrivers';
+export type { IRafDriver } from './rafDrivers';
+
+/**
+ * Returns a project of the given id, or creates one if it doesn't already exist.
+ *
+ * @remarks
+ * If \@tomorrowevening/theatre-studio is also loaded, then the state of the project will be managed by the studio.
+ *
+ * [Learn more about exporting](https://www.theatrejs.com/docs/latest/manual/projects#state)
+ *
+ * @example
+ * Usage:
+ * ```ts
+ * import {getProject} from '@tomorrowevening/theatre-core'
+ * const config = {} // the config can be empty when starting a new project
+ * const project = getProject("a-unique-id", config)
+ * ```
+ *
+ * @example
+ * Usage with an explicit state:
+ * ```ts
+ * import {getProject} from '@tomorrowevening/theatre-core'
+ * import state from './saved-state.json'
+ * const config = {state} // here the config contains our saved state
+ * const project = getProject("a-unique-id", config)
+ * ```
+ */
+export declare function getProject(id: string, config?: IProjectConfig): IProject;
+
+/**
+ * Calls `callback` every time the pointed value of `pointer` changes.
+ *
+ * @param pointer - A Pointer (like `object.props.x`)
+ * @param callback - The callback is called every time the value of pointer changes
+ * @param rafDriver - (optional) The `rafDriver` to use. Learn how to use `rafDriver`s [from the docs](https://www.theatrejs.com/docs/latest/manual/advanced#rafdrivers).
+ * @returns An unsubscribe function
+ *
+ * @example
+ * Usage:
+ * ```ts
+ * import {getProject, onChange} from '@tomorrowevening/theatre-core'
+ *
+ * const obj = getProject("A project").sheet("Scene").object("Box", {position: {x: 0}})
+ *
+ * const usubscribe = onChange(obj.props.position.x, (x) => {
+ *   console.log('position.x changed to:', x)
+ * })
+ *
+ * setTimeout(usubscribe, 10000) // stop listening to changes after 10 seconds
+ * ```
+ */
+export declare function onChange<P extends PointerType<any> | Prism<any>>(
+  pointer: P, 
+  callback: (value: P extends PointerType<infer T> ? T : P extends Prism<infer T> ? T : unknown) => void, 
+  rafDriver?: IRafDriver
+): VoidFn;
+
+/**
+ * Takes a Pointer and returns the value it points to.
+ *
+ * @param pointer - A pointer (like `object.props.x`)
+ * @returns The value the pointer points to
+ *
+ * @example
+ *
+ * Usage
+ * ```ts
+ * import {val, getProject} from '@tomorrowevening/theatre-core'
+ *
+ * const obj = getProject("A project").sheet("Scene").object("Box", {position: {x: 0}})
+ *
+ * console.log(val(obj.props.position.x)) // logs the value of obj.props.x
+ * ```
+ */
+export declare function val<T>(pointer: PointerType<T>): T;
+
+export { IProject, IProjectConfig } from './projects/TheatreProject';
+export { ISequence } from './sequences/TheatreSequence';
+export { ISheetObject } from './sheetObjects/TheatreSheetObject';
+export { ISheet } from './sheets/TheatreSheet';
+export { UnknownShorthandCompoundProps } from './propTypes/index';
+
 /**
  * NOTE: **INTERNAL and UNSTABLE** - This _WILL_ break between minor versions.
  *

package/dist/index.js

@@ -6756,7 +6756,7 @@ var CoreBundle = class {
     return "Theatre_CoreBundle";
   }
   get version() {
-    return "1.0.8";
+    return "1.0.10";
   }
   getBitsForStudio(studio, callback) {
     if (this._studio) {