Sanity Library Reference Docs
    Preparing search index...

    Interface BlueprintInfo

    What a blueprint declares, and the ids that say which Stack it deploys to

    interface BlueprintInfo {
        blueprint: Blueprint;
        configPath?: string;
        module?: BlueprintModule;
        organizationId?: string;
        path: string;
        projectId?: string;
        resources: BlueprintResource<BlueprintResourceLifecycle>[];
        resourcesByName: Record<string, BlueprintResource>;
        scopeId?: string;
        scopeType?: ScopeType;
        sources: {
            organizationId?: ConfigSource;
            projectId?: ConfigSource;
            stackId?: ConfigSource;
        };
        stackId?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    blueprint configPath? module? organizationId? path projectId? resources resourcesByName scopeId? scopeType? sources stackId?

    Properties

    blueprint: Blueprint

    The blueprint document the module returned or the JSON file held

    configPath?: string

    The .sanity/blueprint.config.json that was read, when one exists

    module?: BlueprintModule

    The default export of a JS or TS file. Absent when the file was JSON.

    organizationId?: string
    path: string

    The absolute path of the blueprint file

    projectId?: string
    resources: BlueprintResource<BlueprintResourceLifecycle>[]

    blueprint.resources, or an empty list

    resourcesByName: Record<string, BlueprintResource>

    resources keyed by name. A later duplicate name wins.

    scopeId?: string
    scopeType?: ScopeType

    project when a project id is known, else organization when an organization id is known

    sources: {
        organizationId?: ConfigSource;
        projectId?: ConfigSource;
        stackId?: ConfigSource;
    }

    Which source supplied each id

    stackId?: string

    Settings

    Member Visibility

    On This Page

    Properties