sdk

Variables

studioCMS_SDK

const studioCMS_SDK: {
  addPageToFolderTree: (tree: FolderNode[], folderId: string, newPage: FolderNode) => FolderNode[];
  AUTH: {
     oAuth: {
        create: (data: {
           provider: string;
           providerUserId: string;
           userId: string;
          }) => Promise<{
           provider: string;
           providerUserId: string;
           userId: string;
          }>;
        delete: (userId: string, provider: string) => Promise<DeletionResponse>;
        searchProvidersForId: (providerId: string, userId: string) => Promise<
           | undefined
           | {
           provider: string;
           providerUserId: string;
           userId: string;
          }>;
       };
     permission: {
        currentStatus: (userId: string) => Promise<
           | undefined
           | {
           rank: string;
           user: string;
          }>;
       };
     session: {
        create: (data: {
           expiresAt: Date;
           id: string;
           userId: string;
          }) => Promise<{
           expiresAt: Date;
           id: string;
           userId: string;
          }>;
        delete: (sessionId: string) => Promise<DeletionResponse>;
        sessionWithUser: (sessionId: string) => Promise<{
           session: {
              expiresAt: Date;
              id: string;
              userId: string;
             };
           user: {
              avatar: null | string;
              createdAt: null | Date;
              email: null | string;
              id: string;
              name: string;
              password: null | string;
              updatedAt: null | Date;
              url: null | string;
              username: string;
             };
          }[]>;
        update: (sessionId: string, newDate: Date) => Promise<{
           expiresAt: Date;
           id: string;
           userId: string;
          }[]>;
       };
     user: {
        create: (newUserData: {
           avatar: null | string;
           createdAt: null | Date;
           email: null | string;
           id: string;
           name: string;
           password: null | string;
           updatedAt: null | Date;
           url: null | string;
           username: string;
          }, rank?: "visitor" | "editor" | "admin" | "owner") => Promise<{
           avatar: null | string;
           createdAt: null | Date;
           email: null | string;
           id: string;
           name: string;
           password: null | string;
           updatedAt: null | Date;
           url: null | string;
           username: string;
          }>;
        ghost: {
           create: () => Promise<any>;
           get: () => Promise<any>;
           verifyExists: () => Promise<boolean>;
          };
        searchUsersForUsernameOrEmail: (username: string, email: string) => Promise<{
           emailSearch: {
              avatar: null | string;
              createdAt: null | Date;
              email: null | string;
              id: string;
              name: string;
              password: null | string;
              updatedAt: null | Date;
              url: null | string;
              username: string;
             }[];
           usernameSearch: {
              avatar: null | string;
              createdAt: null | Date;
              email: null | string;
              id: string;
              name: string;
              password: null | string;
              updatedAt: null | Date;
              url: null | string;
              username: string;
             }[];
          }>;
        update: (userId: string, userData: Partial) => Promise<{
           avatar: null | string;
           createdAt: null | Date;
           email: null | string;
           id: string;
           name: string;
           password: null | string;
           updatedAt: null | Date;
           url: null | string;
           username: string;
          }>;
       };
    };
  buildFolderTree: () => Promise<FolderNode[]>;
  clearUserReferences: (userId: string) => Promise<boolean>;
  collectCategories: (categoryIds: number[]) => Promise<{
     description: string;
     id: number;
     meta: unknown;
     name: string;
     parent: null | number;
     slug: string;
    }[]>;
  collectPageData: (page: {
     authorId: null | string;
     categories: unknown;
     contentLang: string;
     contributorIds: unknown;
     description: string;
     draft: null | boolean;
     heroImage: string;
     id: string;
     package: string;
     parentFolder: null | string;
     publishedAt: Date;
     showAuthor: null | boolean;
     showContributors: null | boolean;
     showOnNav: boolean;
     slug: string;
     tags: unknown;
     title: string;
     updatedAt: null | Date;
    }, tree: FolderNode[]) => Promise<CombinedPageData>;
  collectTags: (tagIds: number[]) => Promise<{
     description: string;
     id: number;
     meta: unknown;
     name: string;
     slug: string;
    }[]>;
  collectUserData: (user: {
     avatar: null | string;
     createdAt: null | Date;
     email: null | string;
     id: string;
     name: string;
     password: null | string;
     updatedAt: null | Date;
     url: null | string;
     username: string;
    }) => Promise<CombinedUserData>;
  combineRanks: (rank: string, users: SingleRank[]) => CombinedRank[];
  db: any;
  DELETE: {
     categories: (id: number) => Promise<DeletionResponse>;
     diffTracking: (id: string) => Promise<DeletionResponse>;
     folder: (id: string) => Promise<DeletionResponse>;
     page: (id: string) => Promise<DeletionResponse>;
     pageContent: (id: string) => Promise<DeletionResponse>;
     pageContentLang: (id: string, lang: string) => Promise<DeletionResponse>;
     permissions: (userId: string) => Promise<DeletionResponse>;
     tags: (id: number) => Promise<DeletionResponse>;
     user: (id: string) => Promise<DeletionResponse>;
    };
  diffTracking: {
     clear: (pageId: string) => Promise<void>;
     get: {
        byPageId: {
           all: (pageId: string) => Promise<any>;
           latest: (pageId: string, count: number) => Promise<any>;
          };
        byUserId: {
           all: (userId: string) => Promise<any>;
           latest: (userId: string, count: number) => Promise<any>;
          };
        single: (id: string) => Promise<any>;
        withHtml: (id: string, options?: any) => Promise<any>;
       };
     insert: (userId: string, pageId: string, data: {
        content: {
           end: string;
           start: string;
          };
        metaData: {
           end: Partial<{
              authorId: null | string;
              categories: unknown;
              contentLang: string;
              contributorIds: unknown;
              description: string;
              draft: null | boolean;
              heroImage: string;
              id: string;
              package: string;
              parentFolder: null | string;
              publishedAt: Date;
              showAuthor: null | boolean;
              showContributors: null | boolean;
              showOnNav: boolean;
              slug: string;
              tags: unknown;
              title: string;
              updatedAt: null | Date;
             }>;
           start: Partial<{
              authorId: null | string;
              categories: unknown;
              contentLang: string;
              contributorIds: unknown;
              description: string;
              draft: null | boolean;
              heroImage: string;
              id: string;
              package: string;
              parentFolder: null | string;
              publishedAt: Date;
              showAuthor: null | boolean;
              showContributors: null | boolean;
              showOnNav: boolean;
              slug: string;
              tags: unknown;
              title: string;
              updatedAt: null | Date;
             }>;
          };
       }, diffLength: number) => Promise<any>;
     revertToDiff: (id: string, type: "content" | "data" | "both") => Promise<any>;
    };
  findNodeById: (tree: FolderNode[], id: string) => null | FolderNode;
  findNodeByPath: (tree: FolderNode[], path: string[]) => null | FolderNode;
  findNodesAlongPath: (tree: FolderNode[], path: string[]) => FolderNode[];
  generateRandomIDNumber: (length: number) => number;
  generateRandomPassword: (length: number) => string;
  generateToken: (userId: string) => string;
  GET: {
     database: {
        config: () => Promise<
           | undefined
           | {
           defaultOgImage: null | string;
           description: string;
           diffPerPage: number;
           enableDiffs: boolean;
           gridItems: unknown;
           id: number;
           loginPageBackground: string;
           loginPageCustomImage: null | string;
           siteIcon: null | string;
           title: string;
          }>;
        folders: () => Promise<{
           id: string;
           name: string;
           parent: null | string;
          }[]>;
        pages: (includeDrafts: boolean, tree?: FolderNode[]) => Promise<CombinedPageData[]>;
        users: () => Promise<CombinedUserData[]>;
       };
     databaseEntry: {
        folder: (id: string) => Promise<
           | undefined
           | {
           id: string;
           name: string;
           parent: null | string;
          }>;
        pages: {
           byId: (id: string, tree?: FolderNode[]) => Promise<
              | undefined
              | CombinedPageData>;
           bySlug: (slug: string, tree?: FolderNode[]) => Promise<
              | undefined
              | CombinedPageData>;
          };
        users: {
           byEmail: (email: string) => Promise<
              | undefined
              | CombinedUserData>;
           byId: (id: string) => Promise<
              | undefined
              | CombinedUserData>;
           byUsername: (username: string) => Promise<
              | undefined
              | CombinedUserData>;
          };
       };
     databaseTable: {
        diffTracking: () => Promise<any>;
        oAuthAccounts: () => Promise<any>;
        pageContent: () => Promise<any>;
        pageData: () => Promise<any>;
        pageDataCategories: () => Promise<any>;
        pageDataTags: () => Promise<any>;
        pageFolderStructure: () => Promise<any>;
        permissions: () => Promise<any>;
        sessionTable: () => Promise<any>;
        siteConfig: () => Promise<any>;
        users: () => Promise<any>;
       };
     packagePages: (packageName: string, tree?: FolderNode[]) => Promise<CombinedPageData[]>;
     permissionsLists: {
        admins: () => Promise<SingleRank[]>;
        all: () => Promise<CombinedRank[]>;
        editors: () => Promise<SingleRank[]>;
        owners: () => Promise<SingleRank[]>;
        visitors: () => Promise<SingleRank[]>;
       };
    };
  getAvailableFolders: () => Promise<FolderListItem[]>;
  getFullPath: (tree: FolderNode[], path: string[]) => string[];
  INIT: {
     ghostUser: () => Promise<{
        avatar: null | string;
        createdAt: null | Date;
        email: null | string;
        id: string;
        name: string;
        password: null | string;
        updatedAt: null | Date;
        url: null | string;
        username: string;
       }>;
     siteConfig: (config: {
        defaultOgImage: null | string;
        description: string;
        diffPerPage: number;
        enableDiffs: boolean;
        gridItems: unknown;
        id: number;
        loginPageBackground: string;
        loginPageCustomImage: null | string;
        siteIcon: null | string;
        title: string;
       }) => Promise<{
        defaultOgImage: null | string;
        description: string;
        diffPerPage: number;
        enableDiffs: boolean;
        gridItems: unknown;
        id: number;
        loginPageBackground: string;
        loginPageCustomImage: null | string;
        siteIcon: null | string;
        title: string;
       }>;
    };
  parseIdNumberArray: (ids: unknown) => number[];
  parseIdStringArray: (ids: unknown) => string[];
  POST: {
     databaseEntries: {
        categories: (data: {
           description: string;
           id: number;
           meta: unknown;
           name: string;
           parent: null | number;
           slug: string;
          }[]) => Promise<PageDataCategoriesInsertResponse[]>;
        pages: (pages: MultiPageInsert) => Promise<void>;
        permissions: (data: {
           rank: string;
           user: string;
          }[]) => Promise<{
           rank: string;
           user: string;
          }[]>;
        tags: (data: {
           description: string;
           id: number;
           meta: unknown;
           name: string;
           slug: string;
          }[]) => Promise<PageDataTagsInsertResponse[]>;
       };
     databaseEntry: {
        categories: (category: {
           description: string;
           id: number;
           meta: unknown;
           name: string;
           parent: null | number;
           slug: string;
          }) => Promise<any>;
        diffTracking: (diff: {
           diff: null | string;
           id: string;
           pageContentStart: string;
           pageId: string;
           pageMetaData: unknown;
           timestamp: null | Date;
           userId: string;
          }) => Promise<{
           diff: null | string;
           id: string;
           pageContentStart: string;
           pageId: string;
           pageMetaData: unknown;
           timestamp: null | Date;
           userId: string;
          }[]>;
        folder: (folder: {
           id: string;
           name: string;
           parent: null | string;
          }) => Promise<{
           id: string;
           name: string;
           parent: null | string;
          }[]>;
        pageContent: (pageContent: {
           content: null | string;
           contentId: string;
           contentLang: string;
           id: string;
          }) => Promise<PageContentReturnId[]>;
        pages: (pageData: {
           authorId: null | string;
           categories: unknown;
           contentLang: string;
           contributorIds: unknown;
           description: string;
           draft: null | boolean;
           heroImage: string;
           id: string;
           package: string;
           parentFolder: null | string;
           publishedAt: Date;
           showAuthor: null | boolean;
           showContributors: null | boolean;
           showOnNav: boolean;
           slug: string;
           tags: unknown;
           title: string;
           updatedAt: null | Date;
          }, pageContent: CombinedInsertContent) => Promise<addDatabaseEntryInsertPage>;
        permissions: (userId: string, rank: string) => Promise<{
           rank: string;
           user: string;
          }[]>;
        tags: (tag: {
           description: string;
           id: number;
           meta: unknown;
           name: string;
           slug: string;
          }) => Promise<PageDataTagsInsertResponse[]>;
       };
    };
  resetTokenBucket: {
     check: (token: string) => Promise<boolean>;
     delete: (userId: string) => Promise<void>;
     new: (userId: string) => Promise<any>;
    };
  REST_API: {
     tokens: {
        delete: (userId: string, tokenId: string) => Promise<void>;
        get: (userId: string) => Promise<any>;
        new: (userId: string, description: string) => Promise<any>;
        verify: (key: string) => Promise<
           | false
           | {
           key: any;
           rank: any;
           userId: any;
          }>;
       };
    };
  testToken: (token: string) => any;
  UPDATE: {
     categories: (data: {
        description: string;
        id: number;
        meta: unknown;
        name: string;
        parent: null | number;
        slug: string;
       }) => Promise<{
        description: string;
        id: number;
        meta: unknown;
        name: string;
        parent: null | number;
        slug: string;
       }>;
     folder: (data: {
        id: string;
        name: string;
        parent: null | string;
       }) => Promise<{
        id: string;
        name: string;
        parent: null | string;
       }>;
     page: (data: {
        authorId: null | string;
        categories: unknown;
        contentLang: string;
        contributorIds: unknown;
        description: string;
        draft: null | boolean;
        heroImage: string;
        id: string;
        package: string;
        parentFolder: null | string;
        publishedAt: Date;
        showAuthor: null | boolean;
        showContributors: null | boolean;
        showOnNav: boolean;
        slug: string;
        tags: unknown;
        title: string;
        updatedAt: null | Date;
       }) => Promise<{
        authorId: null | string;
        categories: unknown;
        contentLang: string;
        contributorIds: unknown;
        description: string;
        draft: null | boolean;
        heroImage: string;
        id: string;
        package: string;
        parentFolder: null | string;
        publishedAt: Date;
        showAuthor: null | boolean;
        showContributors: null | boolean;
        showOnNav: boolean;
        slug: string;
        tags: unknown;
        title: string;
        updatedAt: null | Date;
       }>;
     pageContent: (data: {
        content: null | string;
        contentId: string;
        contentLang: string;
        id: string;
       }) => Promise<{
        content: null | string;
        contentId: string;
        contentLang: string;
        id: string;
       }>;
     permissions: (data: {
        rank: string;
        user: string;
       }) => Promise<{
        rank: string;
        user: string;
       }>;
     siteConfig: (data: {
        defaultOgImage: null | string;
        description: string;
        diffPerPage: number;
        enableDiffs: boolean;
        gridItems: unknown;
        id: number;
        loginPageBackground: string;
        loginPageCustomImage: null | string;
        siteIcon: null | string;
        title: string;
       }) => Promise<{
        defaultOgImage: null | string;
        description: string;
        diffPerPage: number;
        enableDiffs: boolean;
        gridItems: unknown;
        id: number;
        loginPageBackground: string;
        loginPageCustomImage: null | string;
        siteIcon: null | string;
        title: string;
       }>;
     tags: (data: {
        description: string;
        id: number;
        meta: unknown;
        name: string;
        slug: string;
       }) => Promise<{
        description: string;
        id: number;
        meta: unknown;
        name: string;
        slug: string;
       }>;
    };
  verifyRank: (users: {
     avatar: null | string;
     createdAt: null | Date;
     email: null | string;
     id: string;
     name: string;
     password: null | string;
     updatedAt: null | Date;
     url: null | string;
     username: string;
    }[], permissions: {
     rank: string;
     user: string;
    }[], rank: string) => SingleRank[];
 } = sdkCore;

Defined in: studiocms/packages/studiocms/src/sdk/index.ts:15

The main SDK export for StudioCMS.

This constant provides access to the core functionality of the StudioCMS SDK.

Type declaration

addPageToFolderTree()

addPageToFolderTree: (tree: FolderNode[], folderId: string, newPage: FolderNode) => FolderNode[];

Adds a new page to the folder tree.

Parameters

tree

FolderNode[]

The root of the folder tree.

folderId

string

The ID of the parent folder.

newPage

FolderNode

The new page to add.

Returns

FolderNode[]

The updated folder tree

AUTH

AUTH: {
  oAuth: {
     create: (data: {
        provider: string;
        providerUserId: string;
        userId: string;
       }) => Promise<{
        provider: string;
        providerUserId: string;
        userId: string;
       }>;
     delete: (userId: string, provider: string) => Promise<DeletionResponse>;
     searchProvidersForId: (providerId: string, userId: string) => Promise<
        | undefined
        | {
        provider: string;
        providerUserId: string;
        userId: string;
       }>;
    };
  permission: {
     currentStatus: (userId: string) => Promise<
        | undefined
        | {
        rank: string;
        user: string;
       }>;
    };
  session: {
     create: (data: {
        expiresAt: Date;
        id: string;
        userId: string;
       }) => Promise<{
        expiresAt: Date;
        id: string;
        userId: string;
       }>;
     delete: (sessionId: string) => Promise<DeletionResponse>;
     sessionWithUser: (sessionId: string) => Promise<{
        session: {
           expiresAt: Date;
           id: string;
           userId: string;
          };
        user: {
           avatar: null | string;
           createdAt: null | Date;
           email: null | string;
           id: string;
           name: string;
           password: null | string;
           updatedAt: null | Date;
           url: null | string;
           username: string;
          };
       }[]>;
     update: (sessionId: string, newDate: Date) => Promise<{
        expiresAt: Date;
        id: string;
        userId: string;
       }[]>;
    };
  user: {
     create: (newUserData: {
        avatar: null | string;
        createdAt: null | Date;
        email: null | string;
        id: string;
        name: string;
        password: null | string;
        updatedAt: null | Date;
        url: null | string;
        username: string;
       }, rank?: "visitor" | "editor" | "admin" | "owner") => Promise<{
        avatar: null | string;
        createdAt: null | Date;
        email: null | string;
        id: string;
        name: string;
        password: null | string;
        updatedAt: null | Date;
        url: null | string;
        username: string;
       }>;
     ghost: {
        create: () => Promise<any>;
        get: () => Promise<any>;
        verifyExists: () => Promise<boolean>;
       };
     searchUsersForUsernameOrEmail: (username: string, email: string) => Promise<{
        emailSearch: {
           avatar: null | string;
           createdAt: null | Date;
           email: null | string;
           id: string;
           name: string;
           password: null | string;
           updatedAt: null | Date;
           url: null | string;
           username: string;
          }[];
        usernameSearch: {
           avatar: null | string;
           createdAt: null | Date;
           email: null | string;
           id: string;
           name: string;
           password: null | string;
           updatedAt: null | Date;
           url: null | string;
           username: string;
          }[];
       }>;
     update: (userId: string, userData: Partial) => Promise<{
        avatar: null | string;
        createdAt: null | Date;
        email: null | string;
        id: string;
        name: string;
        password: null | string;
        updatedAt: null | Date;
        url: null | string;
        username: string;
       }>;
    };
};

AUTH.oAuth

oAuth: {
  create: (data: {
     provider: string;
     providerUserId: string;
     userId: string;
    }) => Promise<{
     provider: string;
     providerUserId: string;
     userId: string;
    }>;
  delete: (userId: string, provider: string) => Promise<DeletionResponse>;
  searchProvidersForId: (providerId: string, userId: string) => Promise<
     | undefined
     | {
     provider: string;
     providerUserId: string;
     userId: string;
    }>;
};

Provides various methods to create, delete, and search for OAuth accounts in the StudioCMS database.

AUTH.oAuth.create()

create: (data: {
  provider: string;
  providerUserId: string;
  userId: string;
 }) => Promise<{
  provider: string;
  providerUserId: string;
  userId: string;
}>;

Creates a new OAuth account in the database.

Parameters

data

The data to insert into the OAuth account table.

provider

string

providerUserId

string

userId

string

Returns

Promise<{ provider: string; providerUserId: string; userId: string; }>

A promise that resolves to the inserted OAuth account.

Throws

If an error occurs while creating the OAuth account.

AUTH.oAuth.delete()

delete: (userId: string, provider: string) => Promise<DeletionResponse>;

Deletes an OAuth account from the database.

Parameters

userId

string

The ID of the user associated with the OAuth account.

provider

string

The provider of the OAuth account.

Returns

Promise<DeletionResponse>

A promise that resolves to a deletion response.

Throws

If an error occurs while deleting the OAuth account.

AUTH.oAuth.searchProvidersForId()

searchProvidersForId: (providerId: string, userId: string) => Promise<
  | undefined
  | {
  provider: string;
  providerUserId: string;
  userId: string;
}>;

Searches for OAuth accounts based on the provider ID and user ID.

Parameters

providerId

string

The provider ID to search for.

userId

string

The user ID to search for.

Returns

Promise< | undefined | { provider: string; providerUserId: string; userId: string; }>

A promise that resolves to the OAuth account data if found, otherwise undefined.

Throws

If an error occurs while searching for the OAuth account.

AUTH.permission

permission: {
  currentStatus: (userId: string) => Promise<
     | undefined
     | {
     rank: string;
     user: string;
    }>;
};

Provides various methods to get and update permissions for users in the StudioCMS database.

AUTH.permission.currentStatus()

currentStatus: (userId: string) => Promise<
  | undefined
  | {
  rank: string;
  user: string;
}>;

Checks the current status of a user’s permissions.

Parameters

userId

string

Returns

Promise< | undefined | { rank: string; user: string; }>

AUTH.session

session: {
  create: (data: {
     expiresAt: Date;
     id: string;
     userId: string;
    }) => Promise<{
     expiresAt: Date;
     id: string;
     userId: string;
    }>;
  delete: (sessionId: string) => Promise<DeletionResponse>;
  sessionWithUser: (sessionId: string) => Promise<{
     session: {
        expiresAt: Date;
        id: string;
        userId: string;
       };
     user: {
        avatar: null | string;
        createdAt: null | Date;
        email: null | string;
        id: string;
        name: string;
        password: null | string;
        updatedAt: null | Date;
        url: null | string;
        username: string;
       };
    }[]>;
  update: (sessionId: string, newDate: Date) => Promise<{
     expiresAt: Date;
     id: string;
     userId: string;
    }[]>;
};

Provides various methods to create, delete, and update sessions in the StudioCMS database.

AUTH.session.create()

create: (data: {
  expiresAt: Date;
  id: string;
  userId: string;
 }) => Promise<{
  expiresAt: Date;
  id: string;
  userId: string;
}>;

Creates a new session in the database.

Parameters

data

The data to insert into the session table.

expiresAt

Date

id?

string

userId

string

Returns

Promise<{ expiresAt: Date; id: string; userId: string; }>

A promise that resolves to the inserted session.

Throws

If an error occurs while creating the session.

AUTH.session.delete()

delete: (sessionId: string) => Promise<DeletionResponse>;

Deletes a session from the database.

Parameters

sessionId

string

The ID of the session to delete.

Returns

Promise<DeletionResponse>

A promise that resolves to a deletion response.

Throws

If an error occurs while deleting the session.

AUTH.session.sessionWithUser()

sessionWithUser: (sessionId: string) => Promise<{
  session: {
     expiresAt: Date;
     id: string;
     userId: string;
    };
  user: {
     avatar: null | string;
     createdAt: null | Date;
     email: null | string;
     id: string;
     name: string;
     password: null | string;
     updatedAt: null | Date;
     url: null | string;
     username: string;
    };
}[]>;

Gets a session with the associated user.

Parameters

sessionId

string

The ID of the session to search for.

Returns

Promise<{ session: { expiresAt: Date; id: string; userId: string; }; user: { avatar: null | string; createdAt: null | Date; email: null | string; id: string; name: string; password: null | string; updatedAt: null | Date; url: null | string; username: string; }; }[]>

A promise that resolves to the session with the associated user.

Throws

If an error occurs while getting the session with the user.

AUTH.session.update()

update: (sessionId: string, newDate: Date) => Promise<{
  expiresAt: Date;
  id: string;
  userId: string;
}[]>;

Updates the expiration date of a session.

Parameters

sessionId

string

The ID of the session to update.

newDate

Date

The new expiration date for the session.

Returns

Promise<{ expiresAt: Date; id: string; userId: string; }[]>

A promise that resolves to the updated session.

Throws

If an error occurs while updating the session.

AUTH.user

user: {
  create: (newUserData: {
     avatar: null | string;
     createdAt: null | Date;
     email: null | string;
     id: string;
     name: string;
     password: null | string;
     updatedAt: null | Date;
     url: null | string;
     username: string;
    }, rank?: "visitor" | "editor" | "admin" | "owner") => Promise<{
     avatar: null | string;
     createdAt: null | Date;
     email: null | string;
     id: string;
     name: string;
     password: null | string;
     updatedAt: null | Date;
     url: null | string;
     username: string;
    }>;
  ghost: {
     create: () => Promise<any>;
     get: () => Promise<any>;
     verifyExists: () => Promise<boolean>;
    };
  searchUsersForUsernameOrEmail: (username: string, email: string) => Promise<{
     emailSearch: {
        avatar: null | string;
        createdAt: null | Date;
        email: null | string;
        id: string;
        name: string;
        password: null | string;
        updatedAt: null | Date;
        url: null | string;
        username: string;
       }[];
     usernameSearch: {
        avatar: null | string;
        createdAt: null | Date;
        email: null | string;
        id: string;
        name: string;
        password: null | string;
        updatedAt: null | Date;
        url: null | string;
        username: string;
       }[];
    }>;
  update: (userId: string, userData: Partial) => Promise<{
     avatar: null | string;
     createdAt: null | Date;
     email: null | string;
     id: string;
     name: string;
     password: null | string;
     updatedAt: null | Date;
     url: null | string;
     username: string;
    }>;
};

Provides various methods to create, update, and search for users in the StudioCMS database.

AUTH.user.create()

create: (newUserData: {
  avatar: null | string;
  createdAt: null | Date;
  email: null | string;
  id: string;
  name: string;
  password: null | string;
  updatedAt: null | Date;
  url: null | string;
  username: string;
 }, rank?: "visitor" | "editor" | "admin" | "owner") => Promise<{
  avatar: null | string;
  createdAt: null | Date;
  email: null | string;
  id: string;
  name: string;
  password: null | string;
  updatedAt: null | Date;
  url: null | string;
  username: string;
}>;

Creates a new user in the database.

Parameters

newUserData

The data to insert into the users table.

avatar?

null | string

createdAt?

null | Date

email?

null | string

id?

string

name

string

password?

null | string

updatedAt?

null | Date

url?

null | string

username

string

rank?

"visitor" | "editor" | "admin" | "owner"

Returns

Promise<{ avatar: null | string; createdAt: null | Date; email: null | string; id: string; name: string; password: null | string; updatedAt: null | Date; url: null | string; username: string; }>

A promise that resolves to the inserted user.

Throws

If an error occurs while creating the user.

AUTH.user.ghost

ghost: {
  create: () => Promise<any>;
  get: () => Promise<any>;
  verifyExists: () => Promise<boolean>;
};

Ghost user utilities.

AUTH.user.ghost.create()

create: () => Promise<any>;

Creates the ghost user in the database.

Returns

Promise<any>

A promise that resolves to the inserted ghost user.

Throws

If an error occurs while creating the ghost user.

AUTH.user.ghost.get()

get: () => Promise<any>;

Gets the ghost user from the database.

Returns

Promise<any>

A promise that resolves to the ghost user.

Throws

If an error occurs while getting the ghost user.

AUTH.user.ghost.verifyExists()

verifyExists: () => Promise<boolean>;

Verifies if the ghost user exists in the database.

Returns

Promise<boolean>

A promise that resolves to a boolean indicating if the ghost user exists.

Throws

If an error occurs while verifying the ghost user.

AUTH.user.searchUsersForUsernameOrEmail()

searchUsersForUsernameOrEmail: (username: string, email: string) => Promise<{
  emailSearch: {
     avatar: null | string;
     createdAt: null | Date;
     email: null | string;
     id: string;
     name: string;
     password: null | string;
     updatedAt: null | Date;
     url: null | string;
     username: string;
    }[];
  usernameSearch: {
     avatar: null | string;
     createdAt: null | Date;
     email: null | string;
     id: string;
     name: string;
     password: null | string;
     updatedAt: null | Date;
     url: null | string;
     username: string;
    }[];
}>;

Searches for users based on the provided username or email.

Parameters

username

string

The username to search for.

email

string

The email to search for.

Returns

Promise<{ emailSearch: { avatar: null | string; createdAt: null | Date; email: null | string; id: string; name: string; password: null | string; updatedAt: null | Date; url: null | string; username: string; }[]; usernameSearch: { avatar: null | string; createdAt: null | Date; email: null | string; id: string; name: string; password: null | string; updatedAt: null | Date; url: null | string; username: string; }[]; }>

A promise that resolves to an object containing the search results for the username and email.

Throws

If an error occurs while searching for the username or email.

AUTH.user.update()

update: (userId: string, userData: Partial) => Promise<{
  avatar: null | string;
  createdAt: null | Date;
  email: null | string;
  id: string;
  name: string;
  password: null | string;
  updatedAt: null | Date;
  url: null | string;
  username: string;
}>;

Updates a user in the database.

Parameters

userId

string

The ID of the user to update.

userData

Partial

The data to update the user with.

Returns

A promise that resolves to the updated user.

Throws

If an error occurs while updating the user.

buildFolderTree()

buildFolderTree: () => Promise<FolderNode[]>;

Gets the folder structure from the database.

Returns

Promise<FolderNode[]>

A promise that resolves to an array of folder nodes representing the folder structure.

clearUserReferences()

clearUserReferences: (userId: string) => Promise<boolean>;

Parameters

userId

string

Returns

Promise<boolean>

collectCategories()

collectCategories: (categoryIds: number[]) => Promise<{
  description: string;
  id: number;
  meta: unknown;
  name: string;
  parent: null | number;
  slug: string;
}[]>;

Collects categories based on the provided category IDs.

Parameters

categoryIds

number[]

An array of category IDs to collect.

Returns

Promise<{ description: string; id: number; meta: unknown; name: string; parent: null | number; slug: string; }[]>

A promise that resolves to an array of collected categories.

Throws

If there is an error while collecting categories.

collectPageData()

collectPageData: (page: {
  authorId: null | string;
  categories: unknown;
  contentLang: string;
  contributorIds: unknown;
  description: string;
  draft: null | boolean;
  heroImage: string;
  id: string;
  package: string;
  parentFolder: null | string;
  publishedAt: Date;
  showAuthor: null | boolean;
  showContributors: null | boolean;
  showOnNav: boolean;
  slug: string;
  tags: unknown;
  title: string;
  updatedAt: null | Date;
}, tree: FolderNode[]) => Promise<CombinedPageData>;

Collects and combines various data related to a page.

Parameters

page

The page data to collect additional information for.

authorId

null | string

contentLang

string

contributorIds

unknown

description

string

draft

null | boolean

heroImage

string

id

string

package

string

parentFolder

null | string

publishedAt

Date

showAuthor

null | boolean

showContributors

null | boolean

showOnNav

boolean

slug

string

title

string

updatedAt

null | Date

tree

FolderNode[]

Returns

Promise<CombinedPageData>

A promise that resolves to the combined page data.

Throws

If an error occurs while collecting page data.

collectTags()

collectTags: (tagIds: number[]) => Promise<{
  description: string;
  id: number;
  meta: unknown;
  name: string;
  slug: string;
}[]>;

Collects tags based on the provided tag IDs.

Parameters

tagIds

number[]

An array of tag IDs to collect.

Returns

Promise<{ description: string; id: number; meta: unknown; name: string; slug: string; }[]>

A promise that resolves to an array of tags.

Throws

If an error occurs while fetching the tags.

collectUserData()

collectUserData: (user: {
  avatar: null | string;
  createdAt: null | Date;
  email: null | string;
  id: string;
  name: string;
  password: null | string;
  updatedAt: null | Date;
  url: null | string;
  username: string;
}) => Promise<CombinedUserData>;

Collects user data by fetching OAuth data and permission data from the database.

Parameters

user

The user object containing user information.

avatar

null | string

createdAt

null | Date

email

null | string

id

string

name

string

password

null | string

updatedAt

null | Date

url

null | string

username

string

Returns

Promise<CombinedUserData>

A promise that resolves to a CombinedUserData object containing the user data, OAuth data, and permissions data.

Throws

If an error occurs while collecting user data.

combineRanks()

combineRanks: (rank: string, users: SingleRank[]) => CombinedRank[];

Combines a given rank with an array of user ranks.

Parameters

rank

string

The rank to be combined with each user.

users

SingleRank[]

An array of user ranks to be combined with the given rank.

Returns

CombinedRank[]

An array of combined ranks, where each element includes the given rank and the properties of a user rank.

db

db: any;

DELETE

DELETE: {
  categories: (id: number) => Promise<DeletionResponse>;
  diffTracking: (id: string) => Promise<DeletionResponse>;
  folder: (id: string) => Promise<DeletionResponse>;
  page: (id: string) => Promise<DeletionResponse>;
  pageContent: (id: string) => Promise<DeletionResponse>;
  pageContentLang: (id: string, lang: string) => Promise<DeletionResponse>;
  permissions: (userId: string) => Promise<DeletionResponse>;
  tags: (id: number) => Promise<DeletionResponse>;
  user: (id: string) => Promise<DeletionResponse>;
};

DELETE.categories()

categories: (id: number) => Promise<DeletionResponse>;

Deletes a category from the database.

Parameters

id

number

The ID of the category to delete.

Returns

Promise<DeletionResponse>

A promise that resolves to a deletion response.

Throws

If an error occurs while deleting the category.

DELETE.diffTracking()

diffTracking: (id: string) => Promise<DeletionResponse>;

Deletes a site configuration from the database.

Parameters

id

string

The ID of the site configuration to delete.

Returns

Promise<DeletionResponse>

A promise that resolves to a deletion response.

Throws

If an error occurs while deleting the site configuration.

DELETE.folder()

folder: (id: string) => Promise<DeletionResponse>;

Deletes a folder from the database.

Parameters

id

string

The ID of the folder to delete.

Returns

Promise<DeletionResponse>

A promise that resolves to a deletion response.

Throws

If an error occurs while deleting the folder.

DELETE.page()

page: (id: string) => Promise<DeletionResponse>;

Deletes a page from the database.

Parameters

id

string

The ID of the page to delete.

Returns

Promise<DeletionResponse>

A promise that resolves to a deletion response.

Throws

If an error occurs while deleting the page.

DELETE.pageContent()

pageContent: (id: string) => Promise<DeletionResponse>;

Deletes a page content from the database.

Parameters

id

string

The ID of the page content to delete.

Returns

Promise<DeletionResponse>

A promise that resolves to a deletion response.

Throws

If an error occurs while deleting the page content.

DELETE.pageContentLang()

pageContentLang: (id: string, lang: string) => Promise<DeletionResponse>;

Deletes a page content lang from the database.

Parameters

id

string

The ID of the page content to delete.

lang

string

The lang of the page content to delete.

Returns

Promise<DeletionResponse>

A promise that resolves to a deletion response.

Throws

If an error occurs while deleting the page content lang.

DELETE.permissions()

permissions: (userId: string) => Promise<DeletionResponse>;

Deletes a permission from the database.

Parameters

userId

string

The ID of the user to delete the permission for.

Returns

Promise<DeletionResponse>

A promise that resolves to a deletion response.

Throws

If an error occurs while deleting the permission.

DELETE.tags()

tags: (id: number) => Promise<DeletionResponse>;

Deletes a tag from the database.

Parameters

id

number

The ID of the tag to delete.

Returns

Promise<DeletionResponse>

A promise that resolves to a deletion response.

Throws

If an error occurs while deleting the tag.

DELETE.user()

user: (id: string) => Promise<DeletionResponse>;

Deletes a user from the database.

Parameters

id

string

The ID of the user to delete.

Returns

Promise<DeletionResponse>

A promise that resolves to a deletion response.

Throws

If an error occurs while deleting the user.

diffTracking

diffTracking: {
  clear: (pageId: string) => Promise<void>;
  get: {
     byPageId: {
        all: (pageId: string) => Promise<any>;
        latest: (pageId: string, count: number) => Promise<any>;
       };
     byUserId: {
        all: (userId: string) => Promise<any>;
        latest: (userId: string, count: number) => Promise<any>;
       };
     single: (id: string) => Promise<any>;
     withHtml: (id: string, options?: any) => Promise<any>;
    };
  insert: (userId: string, pageId: string, data: {
     content: {
        end: string;
        start: string;
       };
     metaData: {
        end: Partial<{
           authorId: null | string;
           categories: unknown;
           contentLang: string;
           contributorIds: unknown;
           description: string;
           draft: null | boolean;
           heroImage: string;
           id: string;
           package: string;
           parentFolder: null | string;
           publishedAt: Date;
           showAuthor: null | boolean;
           showContributors: null | boolean;
           showOnNav: boolean;
           slug: string;
           tags: unknown;
           title: string;
           updatedAt: null | Date;
          }>;
        start: Partial<{
           authorId: null | string;
           categories: unknown;
           contentLang: string;
           contributorIds: unknown;
           description: string;
           draft: null | boolean;
           heroImage: string;
           id: string;
           package: string;
           parentFolder: null | string;
           publishedAt: Date;
           showAuthor: null | boolean;
           showContributors: null | boolean;
           showOnNav: boolean;
           slug: string;
           tags: unknown;
           title: string;
           updatedAt: null | Date;
          }>;
       };
    }, diffLength: number) => Promise<any>;
  revertToDiff: (id: string, type: "content" | "data" | "both") => Promise<any>;
};

diffTracking.clear()

clear: (pageId: string) => Promise<void>;

Parameters

pageId

string

Returns

Promise<void>

diffTracking.get

get: {
  byPageId: {
     all: (pageId: string) => Promise<any>;
     latest: (pageId: string, count: number) => Promise<any>;
    };
  byUserId: {
     all: (userId: string) => Promise<any>;
     latest: (userId: string, count: number) => Promise<any>;
    };
  single: (id: string) => Promise<any>;
  withHtml: (id: string, options?: any) => Promise<any>;
};

diffTracking.get.byPageId

byPageId: {
  all: (pageId: string) => Promise<any>;
  latest: (pageId: string, count: number) => Promise<any>;
};

diffTracking.get.byPageId.all()

all: (pageId: string) => Promise<any>;

Parameters

pageId

string

Returns

Promise<any>

diffTracking.get.byPageId.latest()

latest: (pageId: string, count: number) => Promise<any>;

Parameters

pageId

string

count

number

Returns

Promise<any>

diffTracking.get.byUserId

byUserId: {
  all: (userId: string) => Promise<any>;
  latest: (userId: string, count: number) => Promise<any>;
};

diffTracking.get.byUserId.all()

all: (userId: string) => Promise<any>;

Parameters

userId

string

Returns

Promise<any>

diffTracking.get.byUserId.latest()

latest: (userId: string, count: number) => Promise<any>;

Parameters

userId

string

count

number

Returns

Promise<any>

diffTracking.get.single()

single: (id: string) => Promise<any>;

Parameters

id

string

Returns

Promise<any>

diffTracking.get.withHtml()

withHtml: (id: string, options?: any) => Promise<any>;

Parameters

id

string

options?

any

Returns

Promise<any>

diffTracking.insert()

insert: (userId: string, pageId: string, data: {
  content: {
     end: string;
     start: string;
    };
  metaData: {
     end: Partial<{
        authorId: null | string;
        categories: unknown;
        contentLang: string;
        contributorIds: unknown;
        description: string;
        draft: null | boolean;
        heroImage: string;
        id: string;
        package: string;
        parentFolder: null | string;
        publishedAt: Date;
        showAuthor: null | boolean;
        showContributors: null | boolean;
        showOnNav: boolean;
        slug: string;
        tags: unknown;
        title: string;
        updatedAt: null | Date;
       }>;
     start: Partial<{
        authorId: null | string;
        categories: unknown;
        contentLang: string;
        contributorIds: unknown;
        description: string;
        draft: null | boolean;
        heroImage: string;
        id: string;
        package: string;
        parentFolder: null | string;
        publishedAt: Date;
        showAuthor: null | boolean;
        showContributors: null | boolean;
        showOnNav: boolean;
        slug: string;
        tags: unknown;
        title: string;
        updatedAt: null | Date;
       }>;
    };
}, diffLength: number) => Promise<any>;

Parameters

userId

string

pageId

string

data

content

{ end: string; start: string; }

content.end

string

content.start

string

metaData

{ end: Partial<{ authorId: null | string; categories: unknown; contentLang: string; contributorIds: unknown; description: string; draft: null | boolean; heroImage: string; id: string; package: string; parentFolder: null | string; publishedAt: Date; showAuthor: null | boolean; showContributors: null | boolean; showOnNav: boolean; slug: string; tags: unknown; title: string; updatedAt: null | Date; }>; start: Partial<{ authorId: null | string; categories: unknown; contentLang: string; contributorIds: unknown; description: string; draft: null | boolean; heroImage: string; id: string; package: string; parentFolder: null | string; publishedAt: Date; showAuthor: null | boolean; showContributors: null | boolean; showOnNav: boolean; slug: string; tags: unknown; title: string; updatedAt: null | Date; }>; }

metaData.end

Partial<{ authorId: null | string; categories: unknown; contentLang: string; contributorIds: unknown; description: string; draft: null | boolean; heroImage: string; id: string; package: string; parentFolder: null | string; publishedAt: Date; showAuthor: null | boolean; showContributors: null | boolean; showOnNav: boolean; slug: string; tags: unknown; title: string; updatedAt: null | Date; }>

metaData.start

diffLength

number

Returns

Promise<any>

diffTracking.revertToDiff()

revertToDiff: (id: string, type: "content" | "data" | "both") => Promise<any>;

Parameters

id

string

type

"content" | "data" | "both"

Returns

Promise<any>

findNodeById()

findNodeById: (tree: FolderNode[], id: string) => null | FolderNode;

Finds a node by its ID in the tree.

Parameters

tree

FolderNode[]

id

string

The ID of the node to find.

Returns

null | FolderNode

The node or null if not found.

findNodeByPath()

findNodeByPath: (tree: FolderNode[], path: string[]) => null | FolderNode;

Finds a node in the tree that matches the given URL path.

Parameters

tree

FolderNode[]

The root of the folder tree.

path

string[]

The URL path to locate.

Returns

null | FolderNode

The matching node or null if not found.

findNodesAlongPath()

findNodesAlongPath: (tree: FolderNode[], path: string[]) => FolderNode[];

Finds all nodes along the path to a given URL.

Parameters

tree

FolderNode[]

The root of the folder tree.

path

string[]

The URL path to locate.

Returns

FolderNode[]

The nodes along the path.

generateRandomIDNumber()

generateRandomIDNumber: (length: number) => number;

Generates a random ID number with the specified length.

Parameters

length

number

The length of the random ID number to generate.

Returns

number

A random ID number with the specified length.

generateRandomPassword()

generateRandomPassword: (length: number) => string;

Generates a random password of the specified length.

Parameters

length

number

The length of the password to generate.

Returns

string

A randomly generated password string containing uppercase letters, lowercase letters, and digits.

generateToken()

generateToken: (userId: string) => string;

Generates a JSON Web Token (JWT) for a given user ID.

Parameters

userId

string

The unique identifier of the user for whom the token is being generated.

Returns

string

A signed JWT string that expires in 3 hours.

GET

GET: {
  database: {
     config: () => Promise<
        | undefined
        | {
        defaultOgImage: null | string;
        description: string;
        diffPerPage: number;
        enableDiffs: boolean;
        gridItems: unknown;
        id: number;
        loginPageBackground: string;
        loginPageCustomImage: null | string;
        siteIcon: null | string;
        title: string;
       }>;
     folders: () => Promise<{
        id: string;
        name: string;
        parent: null | string;
       }[]>;
     pages: (includeDrafts: boolean, tree?: FolderNode[]) => Promise<CombinedPageData[]>;
     users: () => Promise<CombinedUserData[]>;
    };
  databaseEntry: {
     folder: (id: string) => Promise<
        | undefined
        | {
        id: string;
        name: string;
        parent: null | string;
       }>;
     pages: {
        byId: (id: string, tree?: FolderNode[]) => Promise<
           | undefined
           | CombinedPageData>;
        bySlug: (slug: string, tree?: FolderNode[]) => Promise<
           | undefined
           | CombinedPageData>;
       };
     users: {
        byEmail: (email: string) => Promise<
           | undefined
           | CombinedUserData>;
        byId: (id: string) => Promise<
           | undefined
           | CombinedUserData>;
        byUsername: (username: string) => Promise<
           | undefined
           | CombinedUserData>;
       };
    };
  databaseTable: {
     diffTracking: () => Promise<any>;
     oAuthAccounts: () => Promise<any>;
     pageContent: () => Promise<any>;
     pageData: () => Promise<any>;
     pageDataCategories: () => Promise<any>;
     pageDataTags: () => Promise<any>;
     pageFolderStructure: () => Promise<any>;
     permissions: () => Promise<any>;
     sessionTable: () => Promise<any>;
     siteConfig: () => Promise<any>;
     users: () => Promise<any>;
    };
  packagePages: (packageName: string, tree?: FolderNode[]) => Promise<CombinedPageData[]>;
  permissionsLists: {
     admins: () => Promise<SingleRank[]>;
     all: () => Promise<CombinedRank[]>;
     editors: () => Promise<SingleRank[]>;
     owners: () => Promise<SingleRank[]>;
     visitors: () => Promise<SingleRank[]>;
    };
};

GET.database

database: {
  config: () => Promise<
     | undefined
     | {
     defaultOgImage: null | string;
     description: string;
     diffPerPage: number;
     enableDiffs: boolean;
     gridItems: unknown;
     id: number;
     loginPageBackground: string;
     loginPageCustomImage: null | string;
     siteIcon: null | string;
     title: string;
    }>;
  folders: () => Promise<{
     id: string;
     name: string;
     parent: null | string;
    }[]>;
  pages: (includeDrafts: boolean, tree?: FolderNode[]) => Promise<CombinedPageData[]>;
  users: () => Promise<CombinedUserData[]>;
};

Retrieves data from the database

GET.database.config()

config: () => Promise<
  | undefined
  | {
  defaultOgImage: null | string;
  description: string;
  diffPerPage: number;
  enableDiffs: boolean;
  gridItems: unknown;
  id: number;
  loginPageBackground: string;
  loginPageCustomImage: null | string;
  siteIcon: null | string;
  title: string;
}>;

Retrieves the site configuration from the database.

Returns

Promise< | undefined | { defaultOgImage: null | string; description: string; diffPerPage: number; enableDiffs: boolean; gridItems: unknown; id: number; loginPageBackground: string; loginPageCustomImage: null | string; siteIcon: null | string; title: string; }>

A promise that resolves to the site configuration.

Throws

If an error occurs while getting the site configuration.

GET.database.folders()

folders: () => Promise<{
  id: string;
  name: string;
  parent: null | string;
}[]>;

Returns

Promise<{ id: string; name: string; parent: null | string; }[]>

GET.database.pages()

pages: (includeDrafts: boolean, tree?: FolderNode[]) => Promise<CombinedPageData[]>;

Retrieves all pages from the database.

Parameters

includeDrafts

boolean = false

tree?

FolderNode[]

Returns

Promise<CombinedPageData[]>

A promise that resolves to an array of combined page data.

Throws

If an error occurs while getting the pages.

GET.database.users()

users: () => Promise<CombinedUserData[]>;

Retrieves all users from the database.

Returns

Promise<CombinedUserData[]>

A promise that resolves to an array of combined user data.

Throws

If an error occurs while getting the users.

GET.databaseEntry

databaseEntry: {
  folder: (id: string) => Promise<
     | undefined
     | {
     id: string;
     name: string;
     parent: null | string;
    }>;
  pages: {
     byId: (id: string, tree?: FolderNode[]) => Promise<
        | undefined
        | CombinedPageData>;
     bySlug: (slug: string, tree?: FolderNode[]) => Promise<
        | undefined
        | CombinedPageData>;
    };
  users: {
     byEmail: (email: string) => Promise<
        | undefined
        | CombinedUserData>;
     byId: (id: string) => Promise<
        | undefined
        | CombinedUserData>;
     byUsername: (username: string) => Promise<
        | undefined
        | CombinedUserData>;
    };
};

Retrieves data from the database by ID.

GET.databaseEntry.folder()

folder: (id: string) => Promise<
  | undefined
  | {
  id: string;
  name: string;
  parent: null | string;
}>;

Parameters

id

string

Returns

Promise< | undefined | { id: string; name: string; parent: null | string; }>

GET.databaseEntry.pages

pages: {
  byId: (id: string, tree?: FolderNode[]) => Promise<
     | undefined
     | CombinedPageData>;
  bySlug: (slug: string, tree?: FolderNode[]) => Promise<
     | undefined
     | CombinedPageData>;
};

Retrieves a page from the database

GET.databaseEntry.pages.byId()

byId: (id: string, tree?: FolderNode[]) => Promise<
  | undefined
| CombinedPageData>;

Retrieves a page by ID.

Parameters

id

string

The ID of the page to retrieve.

tree?

FolderNode[]

Returns

Promise< | undefined | CombinedPageData>

A promise that resolves to the page data.

Throws

If an error occurs while getting the page.

GET.databaseEntry.pages.bySlug()

bySlug: (slug: string, tree?: FolderNode[]) => Promise<
  | undefined
| CombinedPageData>;

Retrieves a page by slug.

Parameters

slug

string

The slug of the page to retrieve.

tree?

FolderNode[]

Returns

Promise< | undefined | CombinedPageData>

A promise that resolves to the page data.

Throws

If an error occurs while getting the page.

GET.databaseEntry.users

users: {
  byEmail: (email: string) => Promise<
     | undefined
     | CombinedUserData>;
  byId: (id: string) => Promise<
     | undefined
     | CombinedUserData>;
  byUsername: (username: string) => Promise<
     | undefined
     | CombinedUserData>;
};

Retrieves a user from the database

GET.databaseEntry.users.byEmail()

byEmail: (email: string) => Promise<
  | undefined
| CombinedUserData>;

Retrieves a user by email.

Parameters

email

string

The email of the user to retrieve.

Returns

Promise< | undefined | CombinedUserData>

A promise that resolves to the user data.

Throws

If an error occurs while getting the user.

GET.databaseEntry.users.byId()

byId: (id: string) => Promise<
  | undefined
| CombinedUserData>;

Retrieves a user by ID.

Parameters

id

string

The ID of the user to retrieve.

Returns

Promise< | undefined | CombinedUserData>

A promise that resolves to the user data.

Throws

If an error occurs while getting the user.

GET.databaseEntry.users.byUsername()

byUsername: (username: string) => Promise<
  | undefined
| CombinedUserData>;

Retrieves a user by username.

Parameters

username

string

The username of the user to retrieve.

Returns

Promise< | undefined | CombinedUserData>

A promise that resolves to the user data.

Throws

If an error occurs while getting the user.

GET.databaseTable

databaseTable: {
  diffTracking: () => Promise<any>;
  oAuthAccounts: () => Promise<any>;
  pageContent: () => Promise<any>;
  pageData: () => Promise<any>;
  pageDataCategories: () => Promise<any>;
  pageDataTags: () => Promise<any>;
  pageFolderStructure: () => Promise<any>;
  permissions: () => Promise<any>;
  sessionTable: () => Promise<any>;
  siteConfig: () => Promise<any>;
  users: () => Promise<any>;
};

Retrieves data from the database tables without any additional processing.

GET.databaseTable.diffTracking()

diffTracking: () => Promise<any>;

Retrieves all data from the diff tracking table.

Returns

Promise<any>

A promise that resolves to an array of diff tracking data.

Throws

If an error occurs while getting the diff tracking data.

GET.databaseTable.oAuthAccounts()

oAuthAccounts: () => Promise<any>;

Retrieves all data from the OAuth accounts table.

Returns

Promise<any>

A promise that resolves to an array of OAuth account data.

Throws

If an error occurs while getting the OAuth accounts.

GET.databaseTable.pageContent()

pageContent: () => Promise<any>;

Retrieves all data from the page content table.

Returns

Promise<any>

A promise that resolves to an array of page content.

Throws

If an error occurs while getting the page content.

GET.databaseTable.pageData()

pageData: () => Promise<any>;

Retrieves all data from the page data table.

Returns

Promise<any>

A promise that resolves to an array of page data.

Throws

If an error occurs while getting the pages.

GET.databaseTable.pageDataCategories()

pageDataCategories: () => Promise<any>;

Retrieves all data from the page data categories table.

Returns

Promise<any>

A promise that resolves to an array of page data categories.

Throws

If an error occurs while getting the page data categories.

GET.databaseTable.pageDataTags()

pageDataTags: () => Promise<any>;

Retrieves all data from the page data tags table.

Returns

Promise<any>

A promise that resolves to an array of page data tags.

Throws

If an error occurs while getting the page data tags.

GET.databaseTable.pageFolderStructure()

pageFolderStructure: () => Promise<any>;

Retrieves all data from the page folder structure table.

Returns

Promise<any>

A promise that resolves to an array of page folder structure data.

Throws

If an error occurs while getting the page folder structure data.

GET.databaseTable.permissions()

permissions: () => Promise<any>;

Retrieves all data from the permissions table.

Returns

Promise<any>

A promise that resolves to an array of permission data.

Throws

If an error occurs while getting the permissions.

GET.databaseTable.sessionTable()

sessionTable: () => Promise<any>;

Retrieves all data from the session table.

Returns

Promise<any>

A promise that resolves to an array of session data.

Throws

If an error occurs while getting the sessions.

GET.databaseTable.siteConfig()

siteConfig: () => Promise<any>;

Retrieves all data from the site config table.

Returns

Promise<any>

A promise that resolves to an array of site configuration data.

Throws

If an error occurs while getting the site configuration.

GET.databaseTable.users()

users: () => Promise<any>;

Retrieves all data from the users table.

Returns

Promise<any>

A promise that resolves to an array of user data.

Throws

If an error occurs while getting the users.

GET.packagePages()

packagePages: (packageName: string, tree?: FolderNode[]) => Promise<CombinedPageData[]>;

Retrieves data from the database by package.

Parameters

packageName

string

tree?

FolderNode[]

Returns

Promise<CombinedPageData[]>

GET.permissionsLists

permissionsLists: {
  admins: () => Promise<SingleRank[]>;
  all: () => Promise<CombinedRank[]>;
  editors: () => Promise<SingleRank[]>;
  owners: () => Promise<SingleRank[]>;
  visitors: () => Promise<SingleRank[]>;
};

Retrieve Permission Lists

GET.permissionsLists.admins()

admins: () => Promise<SingleRank[]>;

Retrieves all admins in the database.

Returns

Promise<SingleRank[]>

A promise that resolves to an array of combined rank data.

Throws

If an error occurs while getting the admins.

GET.permissionsLists.all()

all: () => Promise<CombinedRank[]>;

Retrieves all permissions for users in the database.

Returns

Promise<CombinedRank[]>

A promise that resolves to an array of combined rank data.

Throws

If an error occurs while getting the permissions.

GET.permissionsLists.editors()

editors: () => Promise<SingleRank[]>;

Retrieves all editors in the database.

Returns

Promise<SingleRank[]>

A promise that resolves to an array of combined rank data.

Throws

If an error occurs while getting the editors.

GET.permissionsLists.owners()

owners: () => Promise<SingleRank[]>;

Retrieves all owners in the database.

Returns

Promise<SingleRank[]>

A promise that resolves to an array of combined rank data.

Throws

If an error occurs while getting the owners.

GET.permissionsLists.visitors()

visitors: () => Promise<SingleRank[]>;

Retrieves all visitors in the database.

Returns

Promise<SingleRank[]>

A promise that resolves to an array of combined rank data.

Throws

If an error occurs while getting the visitors.

getAvailableFolders()

getAvailableFolders: () => Promise<FolderListItem[]>;

Gets the available folders from the database.

Returns

Promise<FolderListItem[]>

A promise that resolves to an array of folder list items.

getFullPath()

getFullPath: (tree: FolderNode[], path: string[]) => string[];

Finds the full path to a node based on its URL.

Parameters

tree

FolderNode[]

The root of the folder tree.

path

string[]

The URL path to locate.

Returns

string[]

The full path as an array of node names.

INIT

INIT: {
  ghostUser: () => Promise<{
     avatar: null | string;
     createdAt: null | Date;
     email: null | string;
     id: string;
     name: string;
     password: null | string;
     updatedAt: null | Date;
     url: null | string;
     username: string;
    }>;
  siteConfig: (config: {
     defaultOgImage: null | string;
     description: string;
     diffPerPage: number;
     enableDiffs: boolean;
     gridItems: unknown;
     id: number;
     loginPageBackground: string;
     loginPageCustomImage: null | string;
     siteIcon: null | string;
     title: string;
    }) => Promise<{
     defaultOgImage: null | string;
     description: string;
     diffPerPage: number;
     enableDiffs: boolean;
     gridItems: unknown;
     id: number;
     loginPageBackground: string;
     loginPageCustomImage: null | string;
     siteIcon: null | string;
     title: string;
    }>;
};

INIT.ghostUser()

ghostUser: () => Promise<{
  avatar: null | string;
  createdAt: null | Date;
  email: null | string;
  id: string;
  name: string;
  password: null | string;
  updatedAt: null | Date;
  url: null | string;
  username: string;
}>;

Initializes the StudioCMS Ghost User.

The ghost user is a default user that is used to perform actions on behalf of the system as well as to replace deleted users.

Returns

A promise that resolves to the ghost user record.

Throws

If an error occurs while creating the ghost user.

INIT.siteConfig()

siteConfig: (config: {
  defaultOgImage: null | string;
  description: string;
  diffPerPage: number;
  enableDiffs: boolean;
  gridItems: unknown;
  id: number;
  loginPageBackground: string;
  loginPageCustomImage: null | string;
  siteIcon: null | string;
  title: string;
 }) => Promise<{
  defaultOgImage: null | string;
  description: string;
  diffPerPage: number;
  enableDiffs: boolean;
  gridItems: unknown;
  id: number;
  loginPageBackground: string;
  loginPageCustomImage: null | string;
  siteIcon: null | string;
  title: string;
}>;

Initializes the StudioCMS SiteConfig table with the provided configuration.

Parameters

config

The configuration to insert into the SiteConfig table.

defaultOgImage?

null | string

description

string

diffPerPage?

number

enableDiffs?

boolean

gridItems?

unknown

id?

number

loginPageBackground?

string

loginPageCustomImage?

null | string

siteIcon?

null | string

title

string

Returns

Promise<{ defaultOgImage: null | string; description: string; diffPerPage: number; enableDiffs: boolean; gridItems: unknown; id: number; loginPageBackground: string; loginPageCustomImage: null | string; siteIcon: null | string; title: string; }>

A promise that resolves to the inserted site configuration.

Throws

If an error occurs while creating the site configuration.

parseIdNumberArray()

parseIdNumberArray: (ids: unknown) => number[];

Parses an unknown input and casts it to an array of numbers.

Parameters

ids

unknown

The input to be parsed, expected to be an array of numbers.

Returns

number[]

An array of numbers.

parseIdStringArray()

parseIdStringArray: (ids: unknown) => string[];

Parses the given input as an array of strings.

Parameters

ids

unknown

The input to be parsed, expected to be an array of unknown type.

Returns

string[]

An array of strings parsed from the input.

POST

POST: {
  databaseEntries: {
     categories: (data: {
        description: string;
        id: number;
        meta: unknown;
        name: string;
        parent: null | number;
        slug: string;
       }[]) => Promise<PageDataCategoriesInsertResponse[]>;
     pages: (pages: MultiPageInsert) => Promise<void>;
     permissions: (data: {
        rank: string;
        user: string;
       }[]) => Promise<{
        rank: string;
        user: string;
       }[]>;
     tags: (data: {
        description: string;
        id: number;
        meta: unknown;
        name: string;
        slug: string;
       }[]) => Promise<PageDataTagsInsertResponse[]>;
    };
  databaseEntry: {
     categories: (category: {
        description: string;
        id: number;
        meta: unknown;
        name: string;
        parent: null | number;
        slug: string;
       }) => Promise<any>;
     diffTracking: (diff: {
        diff: null | string;
        id: string;
        pageContentStart: string;
        pageId: string;
        pageMetaData: unknown;
        timestamp: null | Date;
        userId: string;
       }) => Promise<{
        diff: null | string;
        id: string;
        pageContentStart: string;
        pageId: string;
        pageMetaData: unknown;
        timestamp: null | Date;
        userId: string;
       }[]>;
     folder: (folder: {
        id: string;
        name: string;
        parent: null | string;
       }) => Promise<{
        id: string;
        name: string;
        parent: null | string;
       }[]>;
     pageContent: (pageContent: {
        content: null | string;
        contentId: string;
        contentLang: string;
        id: string;
       }) => Promise<PageContentReturnId[]>;
     pages: (pageData: {
        authorId: null | string;
        categories: unknown;
        contentLang: string;
        contributorIds: unknown;
        description: string;
        draft: null | boolean;
        heroImage: string;
        id: string;
        package: string;
        parentFolder: null | string;
        publishedAt: Date;
        showAuthor: null | boolean;
        showContributors: null | boolean;
        showOnNav: boolean;
        slug: string;
        tags: unknown;
        title: string;
        updatedAt: null | Date;
       }, pageContent: CombinedInsertContent) => Promise<addDatabaseEntryInsertPage>;
     permissions: (userId: string, rank: string) => Promise<{
        rank: string;
        user: string;
       }[]>;
     tags: (tag: {
        description: string;
        id: number;
        meta: unknown;
        name: string;
        slug: string;
       }) => Promise<PageDataTagsInsertResponse[]>;
    };
};

POST.databaseEntries

databaseEntries: {
  categories: (data: {
     description: string;
     id: number;
     meta: unknown;
     name: string;
     parent: null | number;
     slug: string;
    }[]) => Promise<PageDataCategoriesInsertResponse[]>;
  pages: (pages: MultiPageInsert) => Promise<void>;
  permissions: (data: {
     rank: string;
     user: string;
    }[]) => Promise<{
     rank: string;
     user: string;
    }[]>;
  tags: (data: {
     description: string;
     id: number;
     meta: unknown;
     name: string;
     slug: string;
    }[]) => Promise<PageDataTagsInsertResponse[]>;
};

Inserts data into the database by Array of Entries

POST.databaseEntries.categories()

categories: (data: {
  description: string;
  id: number;
  meta: unknown;
  name: string;
  parent: null | number;
  slug: string;
}[]) => Promise<PageDataCategoriesInsertResponse[]>;

Inserts multiple categories into the database.

Parameters

data

{ description: string; id: number; meta: unknown; name: string; parent: null | number; slug: string; }[]

The data to insert into the page data categories table.

Returns

Promise<PageDataCategoriesInsertResponse[]>

A promise that resolves to the inserted categories.

Throws

If an error occurs while inserting the categories.

POST.databaseEntries.pages()

pages: (pages: MultiPageInsert) => Promise<void>;

Inserts multiple pages into the database.

Parameters

pages

MultiPageInsert

The data to insert into the page data and page content tables.

Returns

Promise<void>

A promise that resolves to the inserted pages.

Throws

If an error occurs while inserting the pages.

POST.databaseEntries.permissions()

permissions: (data: {
  rank: string;
  user: string;
 }[]) => Promise<{
  rank: string;
  user: string;
}[]>;

Inserts multiple permissions into the database.

Parameters

data

{ rank: string; user: string; }[]

The data to insert into the permissions table.

Returns

Promise<{ rank: string; user: string; }[]>

A promise that resolves to the inserted permissions.

Throws

If an error occurs while inserting the permissions.

POST.databaseEntries.tags()

tags: (data: {
  description: string;
  id: number;
  meta: unknown;
  name: string;
  slug: string;
}[]) => Promise<PageDataTagsInsertResponse[]>;

Inserts multiple tags into the database.

Parameters

data

{ description: string; id: number; meta: unknown; name: string; slug: string; }[]

The data to insert into the page data tags table.

Returns

Promise<PageDataTagsInsertResponse[]>

A promise that resolves to the inserted tags.

Throws

If an error occurs while inserting the tags.

POST.databaseEntry

databaseEntry: {
  categories: (category: {
     description: string;
     id: number;
     meta: unknown;
     name: string;
     parent: null | number;
     slug: string;
    }) => Promise<any>;
  diffTracking: (diff: {
     diff: null | string;
     id: string;
     pageContentStart: string;
     pageId: string;
     pageMetaData: unknown;
     timestamp: null | Date;
     userId: string;
    }) => Promise<{
     diff: null | string;
     id: string;
     pageContentStart: string;
     pageId: string;
     pageMetaData: unknown;
     timestamp: null | Date;
     userId: string;
    }[]>;
  folder: (folder: {
     id: string;
     name: string;
     parent: null | string;
    }) => Promise<{
     id: string;
     name: string;
     parent: null | string;
    }[]>;
  pageContent: (pageContent: {
     content: null | string;
     contentId: string;
     contentLang: string;
     id: string;
    }) => Promise<PageContentReturnId[]>;
  pages: (pageData: {
     authorId: null | string;
     categories: unknown;
     contentLang: string;
     contributorIds: unknown;
     description: string;
     draft: null | boolean;
     heroImage: string;
     id: string;
     package: string;
     parentFolder: null | string;
     publishedAt: Date;
     showAuthor: null | boolean;
     showContributors: null | boolean;
     showOnNav: boolean;
     slug: string;
     tags: unknown;
     title: string;
     updatedAt: null | Date;
    }, pageContent: CombinedInsertContent) => Promise<addDatabaseEntryInsertPage>;
  permissions: (userId: string, rank: string) => Promise<{
     rank: string;
     user: string;
    }[]>;
  tags: (tag: {
     description: string;
     id: number;
     meta: unknown;
     name: string;
     slug: string;
    }) => Promise<PageDataTagsInsertResponse[]>;
};

Inserts data into the database by Entry

POST.databaseEntry.categories()

categories: (category: {
  description: string;
  id: number;
  meta: unknown;
  name: string;
  parent: null | number;
  slug: string;
}) => Promise<any>;

Inserts a new category into the database.

Parameters

description

string

id?

number

meta?

unknown

name

string

parent?

null | number

slug

string

Returns

Promise<any>

A promise that resolves to the inserted category.

Throws

If an error occurs while inserting the category.

POST.databaseEntry.diffTracking()

diffTracking: (diff: {
  diff: null | string;
  id: string;
  pageContentStart: string;
  pageId: string;
  pageMetaData: unknown;
  timestamp: null | Date;
  userId: string;
 }) => Promise<{
  diff: null | string;
  id: string;
  pageContentStart: string;
  pageId: string;
  pageMetaData: unknown;
  timestamp: null | Date;
  userId: string;
}[]>;

Inserts a new diff tracking entry into the database.

Parameters

diff

The data to insert into the diff tracking table.

diff?

null | string

id?

string

pageContentStart

string

pageId

string

pageMetaData?

unknown

timestamp?

null | Date

userId

string

Returns

Promise<{ diff: null | string; id: string; pageContentStart: string; pageId: string; pageMetaData: unknown; timestamp: null | Date; userId: string; }[]>

A promise that resolves to the inserted diff tracking entry.

Throws

If an error occurs while inserting the diff tracking entry.

POST.databaseEntry.folder()

folder: (folder: {
  id: string;
  name: string;
  parent: null | string;
 }) => Promise<{
  id: string;
  name: string;
  parent: null | string;
}[]>;

Inserts a new folder into the database.

Parameters

folder

The data to insert into the page folder structure table.

id?

string

name

string

parent?

null | string

Returns

Promise<{ id: string; name: string; parent: null | string; }[]>

A promise that resolves to the inserted folder.

Throws

If an error occurs while inserting the folder.

POST.databaseEntry.pageContent()

pageContent: (pageContent: {
  content: null | string;
  contentId: string;
  contentLang: string;
  id: string;
}) => Promise<PageContentReturnId[]>;

Inserts new page content into the database.

Parameters

pageContent

The data to insert into the page content table.

content?

null | string

contentId

string

contentLang?

string

id?

string

Returns

Promise<PageContentReturnId[]>

A promise that resolves to the inserted page content.

Throws

If an error occurs while inserting the page content.

POST.databaseEntry.pages()

pages: (pageData: {
  authorId: null | string;
  categories: unknown;
  contentLang: string;
  contributorIds: unknown;
  description: string;
  draft: null | boolean;
  heroImage: string;
  id: string;
  package: string;
  parentFolder: null | string;
  publishedAt: Date;
  showAuthor: null | boolean;
  showContributors: null | boolean;
  showOnNav: boolean;
  slug: string;
  tags: unknown;
  title: string;
  updatedAt: null | Date;
}, pageContent: CombinedInsertContent) => Promise<addDatabaseEntryInsertPage>;

Insert a new page into the database.

Parameters

pageData

The data to insert into the page data table.

authorId?

null | string

categories?

unknown

contentLang?

string

contributorIds?

unknown

description

string

draft?

null | boolean

heroImage?

string

id?

string

package?

string

parentFolder?

null | string

publishedAt?

Date

showAuthor?

null | boolean

showContributors?

null | boolean

showOnNav?

boolean

slug

string

tags?

unknown

title

string

updatedAt?

null | Date

pageContent

CombinedInsertContent

The data to insert into the page content table.

Returns

Promise<addDatabaseEntryInsertPage>

A promise that resolves to the inserted page data and page content.

Throws

If an error occurs while inserting the page.

POST.databaseEntry.permissions()

permissions: (userId: string, rank: string) => Promise<{
  rank: string;
  user: string;
}[]>;

Inserts a new permission into the database.

Parameters

userId

string

The ID of the user to assign the rank to.

rank

string

The rank to assign to the user.

Returns

Promise<{ rank: string; user: string; }[]>

A promise that resolves to the inserted permission.

Throws

If an error occurs while inserting the permission.

POST.databaseEntry.tags()

tags: (tag: {
  description: string;
  id: number;
  meta: unknown;
  name: string;
  slug: string;
}) => Promise<PageDataTagsInsertResponse[]>;

Inserts a new tag into the database.

Parameters

tag

The data to insert into the page data tags table.

description

string

id?

number

meta?

unknown

name

string

slug

string

Returns

Promise<PageDataTagsInsertResponse[]>

A promise that resolves to the inserted tag.

Throws

If an error occurs while inserting the tag.

resetTokenBucket

resetTokenBucket: {
  check: (token: string) => Promise<boolean>;
  delete: (userId: string) => Promise<void>;
  new: (userId: string) => Promise<any>;
};

resetTokenBucket.check()

check: (token: string) => Promise<boolean>;

Parameters

token

string

Returns

Promise<boolean>

resetTokenBucket.delete()

delete: (userId: string) => Promise<void>;

Parameters

userId

string

Returns

Promise<void>

resetTokenBucket.new()

new: (userId: string) => Promise<any>;

Parameters

userId

string

Returns

Promise<any>

REST_API

REST_API: {
  tokens: {
     delete: (userId: string, tokenId: string) => Promise<void>;
     get: (userId: string) => Promise<any>;
     new: (userId: string, description: string) => Promise<any>;
     verify: (key: string) => Promise<
        | false
        | {
        key: any;
        rank: any;
        userId: any;
       }>;
    };
};

REST_API.tokens

tokens: {
  delete: (userId: string, tokenId: string) => Promise<void>;
  get: (userId: string) => Promise<any>;
  new: (userId: string, description: string) => Promise<any>;
  verify: (key: string) => Promise<
     | false
     | {
     key: any;
     rank: any;
     userId: any;
    }>;
};

REST_API.tokens.delete()

delete: (userId: string, tokenId: string) => Promise<void>;

Parameters

userId

string

tokenId

string

Returns

Promise<void>

REST_API.tokens.get()

get: (userId: string) => Promise<any>;

Parameters

userId

string

Returns

Promise<any>

REST_API.tokens.new()

new: (userId: string, description: string) => Promise<any>;

Parameters

userId

string

description

string

Returns

Promise<any>

REST_API.tokens.verify()

verify: (key: string) => Promise<
  | false
  | {
  key: any;
  rank: any;
  userId: any;
}>;

Parameters

key

string

Returns

Promise< | false | { key: any; rank: any; userId: any; }>

testToken()

testToken: (token: string) => any;

Verifies the provided JWT token using the CMS encryption key.

Parameters

token

string

The JWT token to be verified.

Returns

any

The decoded token if verification is successful.

Throws

Will throw an error if the token is invalid or verification fails.

UPDATE

UPDATE: {
  categories: (data: {
     description: string;
     id: number;
     meta: unknown;
     name: string;
     parent: null | number;
     slug: string;
    }) => Promise<{
     description: string;
     id: number;
     meta: unknown;
     name: string;
     parent: null | number;
     slug: string;
    }>;
  folder: (data: {
     id: string;
     name: string;
     parent: null | string;
    }) => Promise<{
     id: string;
     name: string;
     parent: null | string;
    }>;
  page: (data: {
     authorId: null | string;
     categories: unknown;
     contentLang: string;
     contributorIds: unknown;
     description: string;
     draft: null | boolean;
     heroImage: string;
     id: string;
     package: string;
     parentFolder: null | string;
     publishedAt: Date;
     showAuthor: null | boolean;
     showContributors: null | boolean;
     showOnNav: boolean;
     slug: string;
     tags: unknown;
     title: string;
     updatedAt: null | Date;
    }) => Promise<{
     authorId: null | string;
     categories: unknown;
     contentLang: string;
     contributorIds: unknown;
     description: string;
     draft: null | boolean;
     heroImage: string;
     id: string;
     package: string;
     parentFolder: null | string;
     publishedAt: Date;
     showAuthor: null | boolean;
     showContributors: null | boolean;
     showOnNav: boolean;
     slug: string;
     tags: unknown;
     title: string;
     updatedAt: null | Date;
    }>;
  pageContent: (data: {
     content: null | string;
     contentId: string;
     contentLang: string;
     id: string;
    }) => Promise<{
     content: null | string;
     contentId: string;
     contentLang: string;
     id: string;
    }>;
  permissions: (data: {
     rank: string;
     user: string;
    }) => Promise<{
     rank: string;
     user: string;
    }>;
  siteConfig: (data: {
     defaultOgImage: null | string;
     description: string;
     diffPerPage: number;
     enableDiffs: boolean;
     gridItems: unknown;
     id: number;
     loginPageBackground: string;
     loginPageCustomImage: null | string;
     siteIcon: null | string;
     title: string;
    }) => Promise<{
     defaultOgImage: null | string;
     description: string;
     diffPerPage: number;
     enableDiffs: boolean;
     gridItems: unknown;
     id: number;
     loginPageBackground: string;
     loginPageCustomImage: null | string;
     siteIcon: null | string;
     title: string;
    }>;
  tags: (data: {
     description: string;
     id: number;
     meta: unknown;
     name: string;
     slug: string;
    }) => Promise<{
     description: string;
     id: number;
     meta: unknown;
     name: string;
     slug: string;
    }>;
};

UPDATE.categories()

categories: (data: {
  description: string;
  id: number;
  meta: unknown;
  name: string;
  parent: null | number;
  slug: string;
 }) => Promise<{
  description: string;
  id: number;
  meta: unknown;
  name: string;
  parent: null | number;
  slug: string;
}>;

Updates a category in the database.

Parameters

data

The data to update in the page data categories table.

description

string

id

number

name

string

parent

null | number

slug

string

Returns

Promise<{ description: string; id: number; meta: unknown; name: string; parent: null | number; slug: string; }>

A promise that resolves to the updated category.

Throws

If an error occurs while updating the category.

UPDATE.folder()

folder: (data: {
  id: string;
  name: string;
  parent: null | string;
 }) => Promise<{
  id: string;
  name: string;
  parent: null | string;
}>;

Parameters

data

id

string

name

string

parent

null | string

Returns

Promise<{ id: string; name: string; parent: null | string; }>

UPDATE.page()

page: (data: {
  authorId: null | string;
  categories: unknown;
  contentLang: string;
  contributorIds: unknown;
  description: string;
  draft: null | boolean;
  heroImage: string;
  id: string;
  package: string;
  parentFolder: null | string;
  publishedAt: Date;
  showAuthor: null | boolean;
  showContributors: null | boolean;
  showOnNav: boolean;
  slug: string;
  tags: unknown;
  title: string;
  updatedAt: null | Date;
 }) => Promise<{
  authorId: null | string;
  categories: unknown;
  contentLang: string;
  contributorIds: unknown;
  description: string;
  draft: null | boolean;
  heroImage: string;
  id: string;
  package: string;
  parentFolder: null | string;
  publishedAt: Date;
  showAuthor: null | boolean;
  showContributors: null | boolean;
  showOnNav: boolean;
  slug: string;
  tags: unknown;
  title: string;
  updatedAt: null | Date;
}>;

Updates a page in the database.

Parameters

data

The data to update in the page data table.

authorId

null | string

contentLang

string

contributorIds

unknown

description

string

draft

null | boolean

heroImage

string

id

string

package

string

parentFolder

null | string

publishedAt

Date

showAuthor

null | boolean

showContributors

null | boolean

showOnNav

boolean

slug

string

title

string

updatedAt

null | Date

Returns

Promise<{ authorId: null | string; categories: unknown; contentLang: string; contributorIds: unknown; description: string; draft: null | boolean; heroImage: string; id: string; package: string; parentFolder: null | string; publishedAt: Date; showAuthor: null | boolean; showContributors: null | boolean; showOnNav: boolean; slug: string; tags: unknown; title: string; updatedAt: null | Date; }>

A promise that resolves to the updated page data.

Throws

If an error occurs while updating the page.

UPDATE.pageContent()

pageContent: (data: {
  content: null | string;
  contentId: string;
  contentLang: string;
  id: string;
 }) => Promise<{
  content: null | string;
  contentId: string;
  contentLang: string;
  id: string;
}>;

Updates a page content in the database.

Parameters

data

The data to update in the page content table.

content

null | string

contentId

string

contentLang

string

id

string

Returns

Promise<{ content: null | string; contentId: string; contentLang: string; id: string; }>

A promise that resolves to the updated page content.

Throws

If an error occurs while updating the page content.

UPDATE.permissions()

permissions: (data: {
  rank: string;
  user: string;
 }) => Promise<{
  rank: string;
  user: string;
}>;

Updates a permission in the database.

Parameters

data

The data to update in the permissions table.

rank

string

user

string

Returns

Promise<{ rank: string; user: string; }>

A promise that resolves to the updated permission.

Throws

If an error occurs while updating the permission.

UPDATE.siteConfig()

siteConfig: (data: {
  defaultOgImage: null | string;
  description: string;
  diffPerPage: number;
  enableDiffs: boolean;
  gridItems: unknown;
  id: number;
  loginPageBackground: string;
  loginPageCustomImage: null | string;
  siteIcon: null | string;
  title: string;
 }) => Promise<{
  defaultOgImage: null | string;
  description: string;
  diffPerPage: number;
  enableDiffs: boolean;
  gridItems: unknown;
  id: number;
  loginPageBackground: string;
  loginPageCustomImage: null | string;
  siteIcon: null | string;
  title: string;
}>;

Updates a site configuration in the database.

Parameters

data

The data to update in the site config table.

defaultOgImage

null | string

description

string

diffPerPage

number

enableDiffs

boolean

gridItems

unknown

id

number

loginPageBackground

string

loginPageCustomImage

null | string

siteIcon

null | string

title

string

Returns

A promise that resolves to the updated site configuration.

Throws

If an error occurs while updating the site configuration.

UPDATE.tags()

tags: (data: {
  description: string;
  id: number;
  meta: unknown;
  name: string;
  slug: string;
 }) => Promise<{
  description: string;
  id: number;
  meta: unknown;
  name: string;
  slug: string;
}>;

Updates a tag in the database.

Parameters

data

The data to update in the page data tags table.

description

string

id

number

name

string

slug

string

Returns

Promise<{ description: string; id: number; meta: unknown; name: string; slug: string; }>

A promise that resolves to the updated tag.

Throws

If an error occurs while updating the tag.

verifyRank()

verifyRank: (users: {
  avatar: null | string;
  createdAt: null | Date;
  email: null | string;
  id: string;
  name: string;
  password: null | string;
  updatedAt: null | Date;
  url: null | string;
  username: string;
 }[], permissions: {
  rank: string;
  user: string;
 }[], rank: string) => SingleRank[];

Verifies the rank of users based on the provided permissions and rank.

Parameters

users

{ avatar: null | string; createdAt: null | Date; email: null | string; id: string; name: string; password: null | string; updatedAt: null | Date; url: null | string; username: string; }[]

An array of user objects to be verified.

permissions

{ rank: string; user: string; }[]

An array of permission objects that include user ranks.

rank

string

The rank to be verified against the permissions.

Returns

SingleRank[]

An array of objects containing the id and name of users with the specified rank.