@genart-api/adapter-layer/index.d.ts

GenArtAPI platform adapter for layer.com

import type { LayerSDK } from "./api.js";
declare global {
    /**
     * Globally exposed singleton instance of {@link GenArtAPI}
     */
    var $layer: LayerSDK;
}
export interface LayerAdapterOpts {
    /**
     * If true (default if uploaded/hosted on Layer, i.e. layerstatic.com),
     * param changes to params with `reload` update behavior will automatically
     * trigger a reload of the current URL (after 100ms).
     *
     * @remarks
     * When running on localhost (e.g. via the Layer sandbox), auto reload is
     * NOT enabled by default, since the sandbox handles param updates
     * differently (via updating URL params) than Layer's GenStudio editor does.
     */
    autoReload: boolean;
    /**
     * If true (default if uploaded/hosted on Layer, i.e. layerstatic.com),
     * params declared with `private` (aka artist-only) edit permission will not
     * be exposed to the Layer SDK and therefore will be hidden in Layer's
     * GenStudio variation editor (which doesn't (yet?) consider `private` vs.
     * `protected` aka artist vs. curator edit permissions).
     */
    hidePrivate: boolean;
}
export * from "./api.js";