sp-js-provisioning/lib/schema.d.ts

SharePoint provisioning with pure JavaScript

export interface Schema {
    Parameters?: Record<string, string>;
    Version?: string;
    Hooks?: IHooks[];
    Navigation?: INavigation;
    CustomActions?: ICustomAction[];
    ComposedLook?: IComposedLook;
    WebSettings?: IWebSettings;
    Features?: IFeature[];
    Lists?: IListInstance[];
    Files?: IFileObject[];
    PropertyBagEntries?: IPropertyBagEntry[];
    ClientSidePages?: IClientSidePage[];
    SiteFields?: string[];
    ContentTypes?: IContentType[];
    Taxonomy?: ITaxonomy;
    [key: string]: any;
}
export default Schema;
export interface ITermGroup {
    Id: string;
    Name: string;
}
export interface ITerm {
    Id: string;
    Name: string;
    SortOrder?: number;
    CustomProperties?: Record<string, string>;
}
export interface ITermSet {
    Id: string;
    Name: string;
    Description?: string;
    IsOpenForTermCreation?: boolean;
    Terms?: ITerm[];
    /**
     * When true, terms that already exist (matched by Id) get any **missing**
     * entries from {@link ITerm.CustomProperties} added. A property that already
     * exists on the term is left as-is even if its value differs from the
     * template (existing values are never overwritten); the term's name/labels
     * are also left untouched. Without this flag existing terms are not modified
     * at all. Use it to backfill custom properties (e.g. PhaseSubText /
     * PhaseDescription) onto a term set provisioned before those properties
     * existed.
     */
    UpdateExistingTerms?: boolean;
}
export interface ITaxonomy {
    TermGroup: ITermGroup;
    TermSets: ITermSet[];
}
export interface IFieldReference {
    ID: string;
    Name?: string;
    Required?: boolean;
    Hidden?: boolean;
}
export interface IContentType {
    ID: string;
    Name: string;
    Description: string;
    Group: string;
    FieldRefs: IFieldReference[];
}
export interface IClientSideControl {
    Id: string;
    Properties: {
        [key: string]: any;
    };
    ServerProcessedContent?: {
        htmlStrings: Record<string, string>;
        searchablePlainTexts: Record<string, string>;
        imageSources: Record<string, string>;
        links: Record<string, string>;
    };
    Text?: string;
}
export interface IClientSidePageColumn {
    Factor: any;
    Controls: IClientSideControl[];
}
export interface IClientSidePageSection {
    Columns: IClientSidePageColumn[];
}
export interface IClientSidePage {
    Name: string;
    Title: string;
    PageLayoutType: any;
    CommentsDisabled?: boolean;
    Sections?: IClientSidePageSection[];
    VerticalSection?: IClientSideControl[];
    Overwrite?: boolean;
}
export interface IFeature {
    id: string;
    deactivate: boolean;
    force: boolean;
}
export interface IFileObject {
    Folder: string;
    Src: string;
    Url: string;
    Overwrite?: boolean;
    RemoveExistingWebParts?: boolean;
    WebParts?: IWebPart[];
    Properties?: {
        [key: string]: string | number;
    };
}
export interface IWebPartPropertyOverride {
    name: string;
    type: string;
    value: string;
}
export interface IWebPart {
    Title: string;
    Zone: string;
    Order: number;
    Contents: IWebPartContents;
    PropertyOverrides?: IWebPartPropertyOverride[];
    ListView?: {
        List: string;
        View: IListView;
    };
}
export interface IWebPartContents {
    Xml?: string;
    FileSrc?: string;
}
export interface IComposedLook {
    ColorPaletteUrl: string;
    FontSchemeUrl: string;
    BackgroundImageUrl: string;
}
export interface ICustomAction {
    Name: string;
    Description?: string;
    Title: string;
    Location: string;
    Url: string;
    [key: string]: string;
}
export interface IWebSettings {
    WelcomePage?: string;
    AlternateCssUrl?: string;
    SaveSiteAsTemplateEnabled?: boolean;
    MasterUrl?: string;
    CustomMasterUrl?: string;
    RecycleBinEnabled?: boolean;
    TreeViewEnabled?: boolean;
    QuickLaunchEnabled?: boolean;
    SiteLogoUrl?: string;
    [key: string]: string | boolean;
}
export interface IHooks {
    Title?: string;
    Url: string;
    Method: string;
    Headers?: Headers;
    Body?: Body;
}
export interface INavigation {
    QuickLaunch?: INavigationNode[];
    TopNavigationBar?: INavigationNode[];
}
export interface INavigationNode {
    Title: string;
    Url: string;
    IgnoreExisting?: boolean;
    Children?: INavigationNode[];
}
export interface IRoleAssignment {
    Principal: string;
    RoleDefinition: string;
}
export interface IListSecurity {
    BreakRoleInheritance?: boolean;
    CopyRoleAssignments?: boolean;
    ClearSubscopes?: boolean;
    RoleAssignments?: IRoleAssignment[];
}
export interface IListInstance {
    Title: string;
    Description: string;
    Template: number;
    ContentTypesEnabled: boolean;
    RemoveExistingContentTypes?: boolean;
    ContentTypeBindings?: IContentTypeBinding[];
    Fields?: string[];
    FieldRefs?: IListInstanceFieldReference[];
    Views?: IListView[];
    RemoveExistingViews?: boolean;
    DataRows?: IDataRows;
    Folders?: IFolder[];
    Security?: IListSecurity;
    AdditionalSettings?: {
        DefaultContentApprovalWorkflowId?: string;
        DefaultDisplayFormUrl?: string;
        DefaultEditFormUrl?: string;
        DefaultNewFormUrl?: string;
        Description?: string;
        Direction?: string;
        DocumentTemplateUrl?: string;
        /**
         * Reader = 0; Author = 1; Approver = 2.
         */
        DraftVersionVisibility?: number;
        EnableAttachments?: boolean;
        EnableFolderCreation?: boolean;
        EnableMinorVersions?: boolean;
        EnableModeration?: boolean;
        EnableVersioning?: boolean;
        ForceCheckout?: boolean;
        Hidden?: boolean;
        IrmEnabled?: boolean;
        IrmExpire?: boolean;
        IrmReject?: boolean;
        IsApplicationList?: boolean;
        NoCrawl?: boolean;
        OnQuickLaunch?: boolean;
        Title?: string;
        ValidationFormula?: string;
        ValidationMessage?: string;
        [key: string]: string | boolean | number;
    };
}
/**
 * Seed data for a list (provisioned after fields/content types/views exist).
 *
 * Rows are upserted: when {@link KeyColumn} is set, an existing item whose
 * KeyColumn matches is updated (or skipped, per {@link UpdateBehavior}) instead
 * of creating a duplicate — so re-running the template is idempotent. Without a
 * KeyColumn every row is added.
 */
export interface IDataRows {
    /** Field internal name used to match existing rows for idempotent upsert. */
    KeyColumn?: string;
    /** When a row matches {@link KeyColumn}: `Overwrite` (default) or `Skip`. */
    UpdateBehavior?: 'Overwrite' | 'Skip';
    Rows: IDataRow[];
}
/**
 * One row: a map of field **internal name** → value. Value shapes by field type:
 * - Text / Note / Number / Currency / Choice / Boolean / DateTime: the raw value.
 * - MultiChoice: `string[]`.
 * - URL: a string, or `{ Url, Description? }`.
 * - Lookup / LookupMulti: an item id (number), `{ lookupId }`, or `{ lookupValue }`
 *   (resolved against the target list's show field). Multi accepts an array.
 * - User / UserMulti: a login/email string, `{ login }`, or a user id. Multi accepts an array.
 * - Taxonomy (`TaxonomyFieldType` / `…Multi`): `{ termId, label }` (label required to
 *   write the hidden note field). Multi accepts an array of `{ termId, label }`.
 */
export interface IDataRow {
    [fieldInternalName: string]: any;
}
/**
 * A folder to provision inside a list / document library. Provisioned after
 * fields, content types and views exist. Creation is idempotent: an existing
 * folder with the same name is left in place and recursion continues into its
 * children, so re-running the template is safe.
 */
export interface IFolder {
    /**
     * Leaf name of the folder (not a path). May contain spaces and Norwegian
     * characters (å, æ, ø) — written as-is; PnPjs handles URL encoding.
     */
    Name: string;
    /** Optional nested subfolders, created beneath this folder. */
    Folders?: IFolder[];
}
export interface IListInstanceFieldReference extends IFieldReference {
    DisplayName?: string;
    AdditionalProperties?: Record<string, string>;
}
export interface IContentTypeBinding {
    ContentTypeID: string;
    Name?: string;
}
export interface IListView {
    Title: string;
    PersonalView?: boolean;
    ViewFields?: string[];
    AdditionalSettings?: {
        ViewQuery?: string;
        RowLimit?: number;
        Paged?: boolean;
        Hidden?: boolean;
        Scope?: 0 | 1;
        DefaultView?: boolean;
        JSLink?: string;
    };
}
export interface IPropertyBagEntry {
    Key: string;
    Value: string;
    Indexed?: boolean;
    Overwrite?: boolean;
}