sdk/tables

Variables

tsAPIKeys

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:41

---

tsDiffTracking

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:104

StudioCMS - Diff Tracking Table

Description

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsEmailVerificationTokens

const tsEmailVerificationTokens: Table<"StudioCMSEmailVerificationTokens", {
  expiresAt: {
     type: "date";
    };
  id: {
     type: "text";
    };
  token: {
     type: "text";
    };
  userId: {
     type: "text";
    };
}>;

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

StudioCMS - Email Verification Tokens Table

Description

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsNotificationSettings

const tsNotificationSettings: Table<"StudioCMSNotificationSettings", {
  emailVerification: {
     type: "boolean";
    };
  id: {
     type: "text";
    };
  oAuthBypassVerification: {
     type: "boolean";
    };
  requireAdminVerification: {
     type: "boolean";
    };
  requireEditorVerification: {
     type: "boolean";
    };
}>;

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

StudioCMS - Notification Settings Table

Description

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsOAuthAccounts

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

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

StudioCMS - OAuth Accounts Table

Description

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsPageContent

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:47

StudioCMS - Page Content Table

Description

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsPageData

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:53

StudioCMS - Page Data Table

Description

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsPageDataCategories

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:59

StudioCMS - Page Data Categories Table

Description

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsPageDataTags

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:68

StudioCMS - Page Data Tags Table

Description

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsPageFolderStructure

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

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

StudioCMS - Page Folder Structure Table

Description

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsPermissions

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

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

StudioCMS - Permissions Table

Description

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsSessionTable

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

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

StudioCMS - Session Table

Description

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsSiteConfig

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

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

StudioCMS - Site Config Table

Description

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsUserResetTokens

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

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

StudioCMS - User Reset Tokens Table

Description

Exported TypeSafe Table definition for use in StudioCMS Integrations

---

tsUsers

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

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

StudioCMS - Users Table

Description

Exported TypeSafe Table definition for use in StudioCMS Integrations

References

tsMetric

Re-exports tsMetric