sanity-plugin-seofields 1.0.1

package/dist/index.d.ts

@@ -0,0 +1,226 @@
+import {ObjectDefinition} from 'sanity'
+import {Plugin as Plugin_2} from 'sanity'
+import {PreviewConfig} from 'sanity'
+
+export declare const allSchemas: (
+  | ({
+      type: 'object'
+      name: 'seoFields'
+    } & Omit<ObjectDefinition, 'preview'> & {
+        preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
+      })
+  | ({
+      type: 'object'
+      name: 'metaAttribute'
+    } & Omit<ObjectDefinition, 'preview'> & {
+        preview?:
+          | PreviewConfig<
+              {
+                attributeName: string
+                attributeValueString: string
+                attributeValueImage: string
+              },
+              {
+                attributeName: string
+                attributeValueString: string
+                attributeValueImage: any
+              }
+            >
+          | undefined
+      })
+  | ({
+      type: 'object'
+      name: 'openGraph'
+    } & Omit<ObjectDefinition, 'preview'> & {
+        preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
+      })
+  | ({
+      type: 'object'
+      name: 'twitter'
+    } & Omit<ObjectDefinition, 'preview'> & {
+        preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
+      })
+  | ({
+      type: 'object'
+      name: 'robots'
+    } & Omit<ObjectDefinition, 'preview'> & {
+        preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
+      })
+  | ({
+      type: 'object'
+      name: 'metaTag'
+    } & Omit<ObjectDefinition, 'preview'> & {
+        preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
+      })
+)[]
+
+export declare const defaultSeoValidationRules: SeoValidationRules
+
+export declare const isMetaAttribute: (obj: any) => obj is MetaAttribute
+
+export declare const isOpenGraphSettings: (obj: any) => obj is OpenGraphSettings
+
+export declare const isSeoFields: (obj: any) => obj is SeoFields
+
+export declare const isTwitterCardSettings: (obj: any) => obj is TwitterCardSettings
+
+export declare interface MetaAttribute {
+  _type: 'metaAttribute'
+  key: string
+  type: 'string' | 'image'
+  value?: string
+  image?: SanityImage
+}
+
+export declare const metaAttributeSchema: {
+  type: 'object'
+  name: 'metaAttribute'
+} & Omit<ObjectDefinition, 'preview'> & {
+    preview?:
+      | PreviewConfig<
+          {
+            attributeName: string
+            attributeValueString: string
+            attributeValueImage: string
+          },
+          {
+            attributeName: string
+            attributeValueString: string
+            attributeValueImage: any
+          }
+        >
+      | undefined
+  }
+
+export declare const metaTagSchema: {
+  type: 'object'
+  name: 'metaTag'
+} & Omit<ObjectDefinition, 'preview'> & {
+    preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
+  }
+
+declare interface MyPluginConfig {}
+
+export declare const openGraphSchema: {
+  type: 'object'
+  name: 'openGraph'
+} & Omit<ObjectDefinition, 'preview'> & {
+    preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
+  }
+
+export declare interface OpenGraphSettings {
+  _type: 'openGraph'
+  title?: string
+  description?: string
+  siteName?: string
+  type?: 'website' | 'article' | 'profile' | 'book' | 'music' | 'video' | 'product'
+  imageType?: 'upload' | 'url'
+  image?: SanityImage
+  imageUrl?: string
+}
+
+export declare interface RobotsSettings {
+  noIndex?: boolean
+  noFollow?: boolean
+}
+
+export declare interface SanityImage {
+  _type: 'image'
+  asset: {
+    _ref: string
+    _type: 'reference'
+  }
+  hotspot?: {
+    x: number
+    y: number
+    height: number
+    width: number
+  }
+  crop?: {
+    top: number
+    bottom: number
+    left: number
+    right: number
+  }
+  alt?: string
+}
+
+export declare interface SanityImageWithAlt extends SanityImage {
+  alt: string
+}
+
+export declare interface SeoFields {
+  _type: 'seoFields'
+  robots?: RobotsSettings
+  preview?: string
+  title?: string
+  description?: string
+  metaImage?: SanityImage
+  keywords?: string[]
+  canonicalUrl?: string
+  openGraph?: OpenGraphSettings
+  twitter?: TwitterCardSettings
+}
+
+/**
+ * Usage in `sanity.config.ts` (or .js)
+ *
+ * ```ts
+ * import {defineConfig} from 'sanity'
+ * import {myPlugin} from 'sanity-plugin-seofields'
+ *
+ * export default defineConfig({
+ *   // ...
+ *   plugins: [seofields()],
+ * })
+ * ```
+ */
+export declare const seofields: Plugin_2<void | MyPluginConfig>
+
+export declare const seoFieldsSchema: {
+  type: 'object'
+  name: 'seoFields'
+} & Omit<ObjectDefinition, 'preview'> & {
+    preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
+  }
+
+export declare interface SeoValidationRules {
+  title: {
+    maxLength: number
+    warningLength: number
+  }
+  description: {
+    maxLength: number
+    warningLength: number
+  }
+  openGraphTitle: {
+    maxLength: number
+  }
+  openGraphDescription: {
+    maxLength: number
+  }
+  twitterTitle: {
+    maxLength: number
+  }
+  twitterDescription: {
+    maxLength: number
+  }
+}
+
+export declare interface TwitterCardSettings {
+  _type: 'twitter'
+  card?: 'summary' | 'summary_large_image' | 'app' | 'player'
+  site?: string
+  title?: string
+  description?: string
+  image?: SanityImageWithAlt
+}
+
+export declare const twitterSchema: {
+  type: 'object'
+  name: 'twitter'
+} & Omit<ObjectDefinition, 'preview'> & {
+    preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
+  }
+
+export {}