@smartcat/sanity-plugin 1.0.0 → 1.0.1

package/dist/index.d.cts

@@ -0,0 +1,122 @@
+import { Plugin as Plugin_2 } from "sanity";
+
+/**
+ * A language an installation can translate into.
+ * `id` is the locale tag used in Sanity (and document-internationalization).
+ * `smartcatLanguage` is the code Smartcat expects; set it only when the Sanity
+ * tag differs from Smartcat's (e.g. id "PL-PL" → smartcatLanguage "pl"). Defaults to `id`.
+ *
+ * @public
+ */
+export declare interface SmartcatLanguage {
+  id: string;
+  title: string;
+  smartcatLanguage?: string;
+}
+
+/**
+ * Plugin configuration, supplied by the consuming Studio.
+ *
+ * @public
+ */
+export declare interface SmartcatPluginConfig {
+  /**
+   * Document types the "Add to translation project" action and status line
+   * appear on. Omit to allow every document type (except the plugin's own
+   * `smartcat.*` types). This affects the Studio UI only — not which linked
+   * documents get pulled into a project (see `rootTypes`).
+   */
+  translatableTypes?: string[];
+  /**
+   * Root/standalone document types — the "include linked documents" crawl stops
+   * when it reaches one (they're translated on their own, as peers). Omit to
+   * inherit the explicitly-configured `translatableTypes`, or `[]` if that is
+   * also omitted (i.e. no boundary: pull in every transitively-linked
+   * translatable document).
+   */
+  rootTypes?: string[];
+  /**
+   * Source language tag for new projects. Required.
+   */
+  sourceLanguage: string;
+  /**
+   * Languages content can be translated into. Used to populate
+   * a project's target languages. Optional at this phase.
+   */
+  languages?: SmartcatLanguage[];
+  /**
+   * Field name `@sanity/document-internationalization` stores each document's
+   * locale in. Must match that plugin's `languageField` setting. Defaults to
+   * `'language'`.
+   */
+  documentI18nPluginLanguageField?: string;
+  /**
+   * How `sanity-plugin-internationalized-array` identifies the locale within an
+   * array field's members. `'language'` (default) for v5+; set to `'_key'` to
+   * support v4.x and lower, which keyed members by the language code.
+   */
+  fieldI18nPluginLanguageField?: string;
+}
+
+/**
+ * Smartcat translation plugin for Sanity Studio.
+ *
+ * - Adds a `smartcat.translationProject` document type (a named set of items).
+ * - Adds an "Add to translation project" document action on the configured
+ *   `translatableTypes`.
+ * - Shows a status line on those types when the document belongs to one or more
+ *   translation projects.
+ *
+ * @public
+ */
+export declare const smartcatTranslation: Plugin_2<SmartcatPluginConfig>;
+
+/**
+ * Schema option this plugin adds, mirroring how `@sanity/document-internationalization`
+ * contributes `options.documentInternationalization.exclude`.
+ *
+ * Set it on a field — or once on a custom type — to force translation of a type
+ * the default allowlist (`string`/`text`/Portable Text) would otherwise skip,
+ * e.g. a custom string alias. The kind is derived from the resolved `jsonType`.
+ */
+export declare interface SmartcatTranslationSchemaOptions {
+  smartcatTranslation?: {
+    /**
+     * Force this field/type into translation even when its base type isn't in the
+     * default allowlist. Overrides a `documentInternationalization.exclude` on the
+     * same field. Ignored if the type has no translatable representation.
+     */
+    include?: boolean;
+  };
+}
+
+/**
+ * Document type for a translation project (a named set of items to translate).
+ *
+ * @public
+ */
+export declare const TRANSLATION_PROJECT_TYPE = "smartcat.translationProject";
+
+/**
+ * Lifecycle of a translation project. Drives the export/import Functions.
+ *
+ * @public
+ */
+export declare type TranslationProjectStatus =
+  | "draft"
+  | "queued"
+  | "sent"
+  | "translating"
+  | "importing"
+  | "downloaded"
+  | "completed"
+  | "error";
+
+export {};
+
+declare module "sanity" {
+  interface StringOptions extends SmartcatTranslationSchemaOptions {}
+  interface TextOptions extends SmartcatTranslationSchemaOptions {}
+  interface ArrayOptions extends SmartcatTranslationSchemaOptions {}
+  interface ObjectOptions extends SmartcatTranslationSchemaOptions {}
+}

package/dist/index.d.ts

@@ -0,0 +1,122 @@
+import { Plugin as Plugin_2 } from "sanity";
+
+/**
+ * A language an installation can translate into.
+ * `id` is the locale tag used in Sanity (and document-internationalization).
+ * `smartcatLanguage` is the code Smartcat expects; set it only when the Sanity
+ * tag differs from Smartcat's (e.g. id "PL-PL" → smartcatLanguage "pl"). Defaults to `id`.
+ *
+ * @public
+ */
+export declare interface SmartcatLanguage {
+  id: string;
+  title: string;
+  smartcatLanguage?: string;
+}
+
+/**
+ * Plugin configuration, supplied by the consuming Studio.
+ *
+ * @public
+ */
+export declare interface SmartcatPluginConfig {
+  /**
+   * Document types the "Add to translation project" action and status line
+   * appear on. Omit to allow every document type (except the plugin's own
+   * `smartcat.*` types). This affects the Studio UI only — not which linked
+   * documents get pulled into a project (see `rootTypes`).
+   */
+  translatableTypes?: string[];
+  /**
+   * Root/standalone document types — the "include linked documents" crawl stops
+   * when it reaches one (they're translated on their own, as peers). Omit to
+   * inherit the explicitly-configured `translatableTypes`, or `[]` if that is
+   * also omitted (i.e. no boundary: pull in every transitively-linked
+   * translatable document).
+   */
+  rootTypes?: string[];
+  /**
+   * Source language tag for new projects. Required.
+   */
+  sourceLanguage: string;
+  /**
+   * Languages content can be translated into. Used to populate
+   * a project's target languages. Optional at this phase.
+   */
+  languages?: SmartcatLanguage[];
+  /**
+   * Field name `@sanity/document-internationalization` stores each document's
+   * locale in. Must match that plugin's `languageField` setting. Defaults to
+   * `'language'`.
+   */
+  documentI18nPluginLanguageField?: string;
+  /**
+   * How `sanity-plugin-internationalized-array` identifies the locale within an
+   * array field's members. `'language'` (default) for v5+; set to `'_key'` to
+   * support v4.x and lower, which keyed members by the language code.
+   */
+  fieldI18nPluginLanguageField?: string;
+}
+
+/**
+ * Smartcat translation plugin for Sanity Studio.
+ *
+ * - Adds a `smartcat.translationProject` document type (a named set of items).
+ * - Adds an "Add to translation project" document action on the configured
+ *   `translatableTypes`.
+ * - Shows a status line on those types when the document belongs to one or more
+ *   translation projects.
+ *
+ * @public
+ */
+export declare const smartcatTranslation: Plugin_2<SmartcatPluginConfig>;
+
+/**
+ * Schema option this plugin adds, mirroring how `@sanity/document-internationalization`
+ * contributes `options.documentInternationalization.exclude`.
+ *
+ * Set it on a field — or once on a custom type — to force translation of a type
+ * the default allowlist (`string`/`text`/Portable Text) would otherwise skip,
+ * e.g. a custom string alias. The kind is derived from the resolved `jsonType`.
+ */
+export declare interface SmartcatTranslationSchemaOptions {
+  smartcatTranslation?: {
+    /**
+     * Force this field/type into translation even when its base type isn't in the
+     * default allowlist. Overrides a `documentInternationalization.exclude` on the
+     * same field. Ignored if the type has no translatable representation.
+     */
+    include?: boolean;
+  };
+}
+
+/**
+ * Document type for a translation project (a named set of items to translate).
+ *
+ * @public
+ */
+export declare const TRANSLATION_PROJECT_TYPE = "smartcat.translationProject";
+
+/**
+ * Lifecycle of a translation project. Drives the export/import Functions.
+ *
+ * @public
+ */
+export declare type TranslationProjectStatus =
+  | "draft"
+  | "queued"
+  | "sent"
+  | "translating"
+  | "importing"
+  | "downloaded"
+  | "completed"
+  | "error";
+
+export {};
+
+declare module "sanity" {
+  interface StringOptions extends SmartcatTranslationSchemaOptions {}
+  interface TextOptions extends SmartcatTranslationSchemaOptions {}
+  interface ArrayOptions extends SmartcatTranslationSchemaOptions {}
+  interface ObjectOptions extends SmartcatTranslationSchemaOptions {}
+}