@genome-spy/core 0.67.0 → 0.68.0

package/dist/src/view/viewSelectors.d.ts

@@ -0,0 +1,148 @@
+/**
+ * Marks a view as the root of an import scope.
+ *
+ * @param {import("./view.js").default} view
+ * @param {string | null} scopeName
+ */
+export function registerImportInstance(view: import("./view.js").default, scopeName: string | null): void;
+/**
+ * Returns import scope info for a view, if it is an import root.
+ *
+ * @param {import("./view.js").default} view
+ * @returns {ImportScopeInfo | undefined}
+ */
+export function getImportScopeInfo(view: import("./view.js").default): ImportScopeInfo | undefined;
+/**
+ * Marks a view as non-addressable for selector resolution.
+ *
+ * @param {import("./view.js").default} view
+ * @param {AddressableOptions} [options]
+ */
+export function markViewAsNonAddressable(view: import("./view.js").default, options?: AddressableOptions): void;
+/**
+ * Returns the import scope chain for a view, using named import instances.
+ *
+ * @param {import("./view.js").default} view
+ * @returns {string[]}
+ */
+export function getViewScopeChain(view: import("./view.js").default): string[];
+/**
+ * Returns a view selector for a view with an explicit name.
+ *
+ * @param {import("./view.js").default} view
+ * @returns {ViewSelector}
+ */
+export function getViewSelector(view: import("./view.js").default): ViewSelector;
+/**
+ * Returns a parameter selector for a parameter registered in a view.
+ *
+ * @param {import("./view.js").default} view
+ * @param {string} paramName
+ * @returns {ParamSelector}
+ */
+export function getParamSelector(view: import("./view.js").default, paramName: string): ParamSelector;
+/**
+ * Returns a stable key for a parameter selector.
+ *
+ * @param {ParamSelector} selector
+ * @returns {string}
+ */
+export function makeParamSelectorKey(selector: ParamSelector): string;
+/**
+ * Enumerates views that can be addressed by selectors.
+ *
+ * @param {import("./view.js").default} root
+ * @returns {import("./view.js").default[]}
+ */
+export function getAddressableViews(root: import("./view.js").default): import("./view.js").default[];
+/**
+ * Visits all addressable views in the hierarchy.
+ *
+ * @param {import("./view.js").default} root
+ * @param {import("./view.js").Visitor} visitor
+ */
+export function visitAddressableViews(root: import("./view.js").default, visitor: import("./view.js").Visitor): void;
+/**
+ * Resolves a view selector to a unique view within the matching scope.
+ *
+ * @param {import("./view.js").default} root
+ * @param {ViewSelector} selector
+ * @returns {import("./view.js").default | undefined}
+ */
+export function resolveViewSelector(root: import("./view.js").default, selector: ViewSelector): import("./view.js").default | undefined;
+/**
+ * Resolves a parameter selector to a unique bookmarkable parameter.
+ *
+ * @param {import("./view.js").default} root
+ * @param {ParamSelector} selector
+ * @returns {ResolvedParam | undefined}
+ */
+export function resolveParamSelector(root: import("./view.js").default, selector: ParamSelector): ResolvedParam | undefined;
+/**
+ * Visits bookmarkable parameters in the view hierarchy.
+ *
+ * @param {import("./view.js").default} root
+ * @param {(entry: BookmarkableParamEntry) => void} visitor
+ */
+export function visitBookmarkableParams(root: import("./view.js").default, visitor: (entry: BookmarkableParamEntry) => void): void;
+/**
+ * Returns bookmarkable parameters in the view hierarchy.
+ *
+ * @param {import("./view.js").default} root
+ * @returns {BookmarkableParamEntry[]}
+ */
+export function getBookmarkableParams(root: import("./view.js").default): BookmarkableParamEntry[];
+/**
+ * Validates naming and scoping constraints for addressable views and parameters.
+ *
+ * @param {import("./view.js").default} root
+ * @returns {SelectorValidationIssue[]}
+ */
+export function validateSelectorConstraints(root: import("./view.js").default): SelectorValidationIssue[];
+/**
+ * Selectors identify views and parameters in a way that stays stable when the
+ * same template/import is instantiated multiple times. They combine a chain of
+ * named import instances (scope) with an explicit view or parameter name so
+ * bookmarkable state and visibility toggles do not rely on globally-unique
+ * names or runtime-only nodes.
+ */
+/**
+ * @typedef {{ scope: string[], view: string }} ViewSelector
+ * @typedef {{ scope: string[], param: string }} ParamSelector
+ * @typedef {{ view: import("./view.js").default, param: import("../spec/parameter.js").Parameter, selector: ParamSelector }} BookmarkableParamEntry
+ * @typedef {{ message: string, scope: string[] }} SelectorValidationIssue
+ * @typedef {{ name: string | null }} ImportScopeInfo
+ * @typedef {"exclude" | "excludeSubtree"} AddressableOverride
+ * @typedef {{ skipSubtree?: boolean }} AddressableOptions
+ * @typedef {{ view: import("./view.js").default, param: import("../spec/parameter.js").Parameter }} ResolvedParam
+ */
+export const PARAM_SELECTOR_KEY_PREFIX: "p:";
+export type ViewSelector = {
+    scope: string[];
+    view: string;
+};
+export type ParamSelector = {
+    scope: string[];
+    param: string;
+};
+export type BookmarkableParamEntry = {
+    view: import("./view.js").default;
+    param: import("../spec/parameter.js").Parameter;
+    selector: ParamSelector;
+};
+export type SelectorValidationIssue = {
+    message: string;
+    scope: string[];
+};
+export type ImportScopeInfo = {
+    name: string | null;
+};
+export type AddressableOverride = "exclude" | "excludeSubtree";
+export type AddressableOptions = {
+    skipSubtree?: boolean;
+};
+export type ResolvedParam = {
+    view: import("./view.js").default;
+    param: import("../spec/parameter.js").Parameter;
+};
+//# sourceMappingURL=viewSelectors.d.ts.map

package/dist/src/view/viewSelectors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"viewSelectors.d.ts","sourceRoot":"","sources":["../../../src/view/viewSelectors.js"],"names":[],"mappings":"AA8BA;;;;;GAKG;AACH,6CAHW,OAAO,WAAW,EAAE,OAAO,aAC3B,MAAM,GAAG,IAAI,QAQvB;AAED;;;;;GAKG;AACH,yCAHW,OAAO,WAAW,EAAE,OAAO,GACzB,eAAe,GAAG,SAAS,CAIvC;AAED;;;;;GAKG;AACH,+CAHW,OAAO,WAAW,EAAE,OAAO,YAC3B,kBAAkB,QAM5B;AAED;;;;;GAKG;AACH,wCAHW,OAAO,WAAW,EAAE,OAAO,GACzB,MAAM,EAAE,CAgBpB;AAED;;;;;GAKG;AACH,sCAHW,OAAO,WAAW,EAAE,OAAO,GACzB,YAAY,CAYxB;AAED;;;;;;GAMG;AACH,uCAJW,OAAO,WAAW,EAAE,OAAO,aAC3B,MAAM,GACJ,aAAa,CAazB;AAED;;;;;GAKG;AACH,+CAHW,aAAa,GACX,MAAM,CAQlB;AAED;;;;;GAKG;AACH,0CAHW,OAAO,WAAW,EAAE,OAAO,GACzB,OAAO,WAAW,EAAE,OAAO,EAAE,CAWzC;AAED;;;;;GAKG;AACH,4CAHW,OAAO,WAAW,EAAE,OAAO,WAC3B,OAAO,WAAW,EAAE,OAAO,QAerC;AAED;;;;;;GAMG;AACH,0CAJW,OAAO,WAAW,EAAE,OAAO,YAC3B,YAAY,GACV,OAAO,WAAW,EAAE,OAAO,GAAG,SAAS,CAmCnD;AAED;;;;;;GAMG;AACH,2CAJW,OAAO,WAAW,EAAE,OAAO,YAC3B,aAAa,GACX,aAAa,GAAG,SAAS,CAuCrC;AAED;;;;;GAKG;AACH,8CAHW,OAAO,WAAW,EAAE,OAAO,WAC3B,CAAC,KAAK,EAAE,sBAAsB,KAAK,IAAI,QAyBjD;AAED;;;;;GAKG;AACH,4CAHW,OAAO,WAAW,EAAE,OAAO,GACzB,sBAAsB,EAAE,CAOpC;AAED;;;;;GAKG;AACH,kDAHW,OAAO,WAAW,EAAE,OAAO,GACzB,uBAAuB,EAAE,CAcrC;AArUD;;;;;;GAMG;AAEH;;;;;;;;;GASG;AAEH,wCAAyC,IAAI,CAAC;2BAVjC;IAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE;4BACjC;IAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE;qCAClC;IAAE,IAAI,EAAE,OAAO,WAAW,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,OAAO,sBAAsB,EAAE,SAAS,CAAC;IAAC,QAAQ,EAAE,aAAa,CAAA;CAAE;sCAC/G;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CAAE;8BACpC;IAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE;kCACvB,SAAS,GAAG,gBAAgB;iCAC5B;IAAE,WAAW,CAAC,EAAE,OAAO,CAAA;CAAE;4BACzB;IAAE,IAAI,EAAE,OAAO,WAAW,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,OAAO,sBAAsB,EAAE,SAAS,CAAA;CAAE"}