sdk/tables

Variables

'Read the “', Variables, '” section'

tsAPIKeys

'Read the “', tsAPIKeys, '” section'

const tsAPIKeys: Table<"StudioCMSAPIKeys", {
  creationDate: {
     type: "date";
    };
  description: {
     type: "text";
    };
  id: {
     type: "text";
    };
  key: {
     type: "text";
    };
  userId: {
     type: "text";
    };
}>;

Defined in: studiocms/packages/studiocms/src/sdk/tables.ts:21

---

tsDiffTracking

'Read the “', tsDiffTracking, '” section'

const tsDiffTracking: Table<"StudioCMSDiffTracking", {
  diff: {
     type: "text";
    };
  id: {
     type: "text";
    };
  pageContentStart: {
     type: "text";
    };
  pageId: {
     type: "text";
    };
  pageMetaData: {
     type: "json";
    };
  timestamp: {
     type: "date";
    };
  userId: {
     type: "text";
    };
}>;

Defined in: studiocms/packages/studiocms/src/sdk/tables.ts:84

StudioCMS - Diff Tracking Table

'Read the “', StudioCMS - Diff Tracking Table, '” section'

Description

'Read the “', Description, '” section'

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsOAuthAccounts

'Read the “', tsOAuthAccounts, '” section'

const tsOAuthAccounts: Table<"StudioCMSOAuthAccounts", {
  provider: {
     type: "text";
    };
  providerUserId: {
     type: "text";
    };
  userId: {
     type: "text";
    };
}>;

Defined in: studiocms/packages/studiocms/src/sdk/tables.ts:78

StudioCMS - OAuth Accounts Table

'Read the “', StudioCMS - OAuth Accounts Table, '” section'

Description

'Read the “', Description, '” section'

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsPageContent

'Read the “', tsPageContent, '” section'

const tsPageContent: Table<"StudioCMSPageContent", {
  content: {
     type: "text";
    };
  contentId: {
     type: "text";
    };
  contentLang: {
     type: "text";
    };
  id: {
     type: "text";
    };
}>;

Defined in: studiocms/packages/studiocms/src/sdk/tables.ts:27

StudioCMS - Page Content Table

'Read the “', StudioCMS - Page Content Table, '” section'

Description

'Read the “', Description, '” section'

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsPageData

'Read the “', tsPageData, '” section'

const tsPageData: Table<"StudioCMSPageData", {
  authorId: {
     type: "text";
    };
  categories: {
     type: "json";
    };
  contentLang: {
     type: "text";
    };
  contributorIds: {
     type: "json";
    };
  description: {
     type: "text";
    };
  draft: {
     type: "boolean";
    };
  heroImage: {
     type: "text";
    };
  id: {
     type: "text";
    };
  package: {
     type: "text";
    };
  parentFolder: {
     type: "text";
    };
  publishedAt: {
     type: "date";
    };
  showAuthor: {
     type: "boolean";
    };
  showContributors: {
     type: "boolean";
    };
  showOnNav: {
     type: "boolean";
    };
  slug: {
     type: "text";
    };
  tags: {
     type: "json";
    };
  title: {
     type: "text";
    };
  updatedAt: {
     type: "date";
    };
}>;

Defined in: studiocms/packages/studiocms/src/sdk/tables.ts:33

StudioCMS - Page Data Table

'Read the “', StudioCMS - Page Data Table, '” section'

Description

'Read the “', Description, '” section'

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsPageDataCategories

'Read the “', tsPageDataCategories, '” section'

const tsPageDataCategories: Table<"StudioCMSPageDataCategories", {
  description: {
     type: "text";
    };
  id: {
     type: "number";
    };
  meta: {
     type: "json";
    };
  name: {
     type: "text";
    };
  parent: {
     type: "number";
    };
  slug: {
     type: "text";
    };
}>;

Defined in: studiocms/packages/studiocms/src/sdk/tables.ts:39

StudioCMS - Page Data Categories Table

'Read the “', StudioCMS - Page Data Categories Table, '” section'

Description

'Read the “', Description, '” section'

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsPageDataTags

'Read the “', tsPageDataTags, '” section'

const tsPageDataTags: Table<"StudioCMSPageDataTags", {
  description: {
     type: "text";
    };
  id: {
     type: "number";
    };
  meta: {
     type: "json";
    };
  name: {
     type: "text";
    };
  slug: {
     type: "text";
    };
}>;

Defined in: studiocms/packages/studiocms/src/sdk/tables.ts:48

StudioCMS - Page Data Tags Table

'Read the “', StudioCMS - Page Data Tags Table, '” section'

Description

'Read the “', Description, '” section'

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsPageFolderStructure

'Read the “', tsPageFolderStructure, '” section'

const tsPageFolderStructure: Table<"StudioCMSPageFolderStructure", {
  id: {
     type: "text";
    };
  name: {
     type: "text";
    };
  parent: {
     type: "text";
    };
}>;

Defined in: studiocms/packages/studiocms/src/sdk/tables.ts:90

StudioCMS - Page Folder Structure Table

'Read the “', StudioCMS - Page Folder Structure Table, '” section'

Description

'Read the “', Description, '” section'

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsPermissions

'Read the “', tsPermissions, '” section'

const tsPermissions: Table<"StudioCMSPermissions", {
  rank: {
     type: "text";
    };
  user: {
     type: "text";
    };
}>;

Defined in: studiocms/packages/studiocms/src/sdk/tables.ts:54

StudioCMS - Permissions Table

'Read the “', StudioCMS - Permissions Table, '” section'

Description

'Read the “', Description, '” section'

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsSessionTable

'Read the “', tsSessionTable, '” section'

const tsSessionTable: Table<"StudioCMSSessionTable", {
  expiresAt: {
     type: "date";
    };
  id: {
     type: "text";
    };
  userId: {
     type: "text";
    };
}>;

Defined in: studiocms/packages/studiocms/src/sdk/tables.ts:60

StudioCMS - Session Table

'Read the “', StudioCMS - Session Table, '” section'

Description

'Read the “', Description, '” section'

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsSiteConfig

'Read the “', tsSiteConfig, '” section'

const tsSiteConfig: Table<"StudioCMSSiteConfig", {
  defaultOgImage: {
     type: "text";
    };
  description: {
     type: "text";
    };
  diffPerPage: {
     type: "number";
    };
  enableDiffs: {
     type: "boolean";
    };
  gridItems: {
     type: "json";
    };
  id: {
     type: "number";
    };
  loginPageBackground: {
     type: "text";
    };
  loginPageCustomImage: {
     type: "text";
    };
  siteIcon: {
     type: "text";
    };
  title: {
     type: "text";
    };
}>;

Defined in: studiocms/packages/studiocms/src/sdk/tables.ts:66

StudioCMS - Site Config Table

'Read the “', StudioCMS - Site Config Table, '” section'

Description

'Read the “', Description, '” section'

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsUserResetTokens

'Read the “', tsUserResetTokens, '” section'

const tsUserResetTokens: Table<"StudioCMSUserResetTokens", {
  id: {
     type: "text";
    };
  token: {
     type: "text";
    };
  userId: {
     type: "text";
    };
}>;

Defined in: studiocms/packages/studiocms/src/sdk/tables.ts:99

StudioCMS - User Reset Tokens Table

'Read the “', StudioCMS - User Reset Tokens Table, '” section'

Description

'Read the “', Description, '” section'

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsUsers

'Read the “', tsUsers, '” section'

const tsUsers: Table<"StudioCMSUsers", {
  avatar: {
     type: "text";
    };
  createdAt: {
     type: "date";
    };
  email: {
     type: "text";
    };
  id: {
     type: "text";
    };
  name: {
     type: "text";
    };
  password: {
     type: "text";
    };
  updatedAt: {
     type: "date";
    };
  url: {
     type: "text";
    };
  username: {
     type: "text";
    };
}>;

Defined in: studiocms/packages/studiocms/src/sdk/tables.ts:72

StudioCMS - Users Table

'Read the “', StudioCMS - Users Table, '” section'

Description

'Read the “', Description, '” section'

Exported TypeSafe Table definition for use in StudioCMS Integrations

References

'Read the “', References, '” section'

tsMetric

'Read the “', tsMetric, '” section'

Re-exports tsMetric