@sanity/document-internationalization 0.0.1-beta.1

package/lib/structure/utils/fixBaseDocumentRefs.d.ts

@@ -0,0 +1,2 @@
+import { Ti18nDocument } from '../../types';
+export declare const fixBaseDocumentRefs: (schema: string, translatedDocuments: Ti18nDocument[]) => Promise<void>;

package/lib/structure/utils/fixBaseLanguageMismatch.d.ts

@@ -0,0 +1,2 @@
+import { Ti18nDocument } from '../../types';
+export declare const fixBaseLanguageMismatch: (schema: string, basedocuments: Ti18nDocument[]) => Promise<void>;

package/lib/structure/utils/fixIdStructureMismatchDocuments.d.ts

@@ -0,0 +1,2 @@
+import { Ti18nDocument } from '../../types';
+export declare const fixIdStructureMismatchDocuments: (schema: string, documents: Ti18nDocument[]) => Promise<void>;

package/lib/structure/utils/fixLanguageFields.d.ts

@@ -0,0 +1,2 @@
+import { Ti18nDocument } from '../../types';
+export declare const fixLanguageFields: (schema: string, documents: Ti18nDocument[]) => Promise<void>;

package/lib/structure/utils/fixOrphanedDocuments.d.ts

@@ -0,0 +1,2 @@
+import { Ti18nDocument } from '../../types';
+export declare const fixOrphanedDocuments: (basedocuments: Ti18nDocument[], translatedDocuments: Ti18nDocument[]) => Promise<void>;

package/lib/structure/utils/fixReferenceBehaviorMismatch.d.ts

@@ -0,0 +1,2 @@
+import { Ti18nDocument } from '../../types';
+export declare const fixReferenceBehaviorMismatch: (schema: string, baseDocuments: Ti18nDocument[], translatedDocuments: Ti18nDocument[]) => Promise<void>;

package/lib/structure/utils/fixTranslationRefs.d.ts

@@ -0,0 +1,2 @@
+import { Ti18nDocument } from '../../types';
+export declare const fixTranslationRefs: (schema: string, baseDocuments: Ti18nDocument[], translatedDocuments: Ti18nDocument[]) => Promise<void>;

package/lib/structure/utils/index.d.ts

@@ -0,0 +1,6 @@
+export * from './fixIdStructureMismatchDocuments';
+export * from './fixLanguageFields';
+export * from './fixTranslationRefs';
+export * from './fixOrphanedDocuments';
+export * from './fixBaseLanguageMismatch';
+export * from './fixBaseDocumentRefs';

package/lib/types/IEditState.d.ts

@@ -0,0 +1,5 @@
+import type { SanityDocument } from '@sanity/client';
+export interface IEditState<T extends Record<string, any> = Record<string, any>> {
+    draft?: SanityDocument<T>;
+    published?: SanityDocument<T>;
+}

package/lib/types/ILanguageObject.d.ts

@@ -0,0 +1,6 @@
+export interface ILanguageObject {
+    id: string;
+    title: string;
+    isCurrentLanguage?: boolean;
+    isBase?: boolean;
+}

package/lib/types/ILanguageQuery.d.ts

@@ -0,0 +1,10 @@
+export interface ILanguageQuery {
+    query: string;
+    value: string | {
+        id: string;
+        title: string;
+    } | {
+        name: string;
+        title: string;
+    };
+}

package/lib/types/IResolverProps.d.ts

@@ -0,0 +1,9 @@
+import { SanityDocument } from '@sanity/client';
+export interface IResolverProps<T = any> {
+    id: string;
+    type: string;
+    liveEdit: boolean;
+    draft?: SanityDocument<T>;
+    published?: SanityDocument<T>;
+    onComplete?: () => void;
+}

package/lib/types/ITranslationRef.d.ts

@@ -0,0 +1,6 @@
+export interface ITranslationRef {
+    _key: string;
+    _type: 'reference';
+    _ref: string;
+    _weak?: boolean;
+}

package/lib/types/IType.d.ts

@@ -0,0 +1,38 @@
+import { TLanguagesOption } from './TLanguagesOption';
+import { ObjectSchemaTypeWithOptions } from '@sanity/types';
+export interface IField {
+    name: string;
+    type: IType;
+    readOnly?: boolean;
+}
+export interface IFieldSet {
+    name: string;
+    title: string;
+    description: string;
+    single: boolean;
+    options: ObjectSchemaTypeWithOptions['options'];
+    field: IField;
+    fields: IField[];
+}
+export interface IType {
+    name: string;
+    title: string;
+    description: string;
+    hidden?: boolean;
+    level: number;
+    type: string;
+    jsonType: string;
+    fields: IField[];
+    fieldsets: IFieldSet[];
+    options: ObjectSchemaTypeWithOptions['options'] & {
+        base?: string;
+        i18n?: boolean;
+        languages?: TLanguagesOption;
+        css?: (classNames: Record<string, string>) => string;
+        messages?: {
+            loading?: string;
+            missingTranslations?: string;
+        };
+        [key: string]: any;
+    };
+}

package/lib/types/IUseDocumentOperationResult.d.ts

@@ -0,0 +1,11 @@
+declare type ExecutablAction = {
+    disabled?: string;
+    execute: (...args: any[]) => void;
+};
+export interface IUseDocumentOperationResult {
+    patch: ExecutablAction;
+    publish: ExecutablAction;
+    duplicate: ExecutablAction;
+    delete: ExecutablAction;
+}
+export {};

package/lib/types/TFieldNamesConfig.d.ts

@@ -0,0 +1,5 @@
+export declare type TFieldNamesConfig = {
+    lang?: string;
+    references?: string;
+    baseReference?: string;
+};

package/lib/types/TLanguage.d.ts

@@ -0,0 +1,2 @@
+import { ILanguageObject } from './ILanguageObject';
+export declare type Tlanguage = string | ILanguageObject;

package/lib/types/TLanguagesOption.d.ts

@@ -0,0 +1,3 @@
+import { ILanguageQuery } from './ILanguageQuery';
+import { ILanguageObject } from './ILanguageObject';
+export declare type TLanguagesOption = (string | ILanguageObject)[] | ILanguageQuery;

package/lib/types/TSchema.d.ts

@@ -0,0 +1,6 @@
+export declare type TSchema<T = any> = T & {
+    name: string;
+    title: string;
+    icon?: any;
+    fields: any[];
+};

package/lib/types/Ti18nConfig.d.ts

@@ -0,0 +1,10 @@
+import { TLanguagesOption } from './TLanguagesOption';
+import { TFieldNamesConfig } from './TFieldNamesConfig';
+import { IdStructure, ReferenceBehavior } from '../constants';
+export declare type Ti18nConfig = {
+    base?: string;
+    languages?: TLanguagesOption;
+    idStructure?: IdStructure;
+    referenceBehavior?: ReferenceBehavior;
+    fieldNames?: TFieldNamesConfig;
+};

package/lib/types/Ti18nDocument.d.ts

@@ -0,0 +1,13 @@
+import type { SanityDocument } from '@sanity/client';
+export declare type Ti18nDocument<D = any> = SanityDocument<D> & {
+    __i18n_lang?: string;
+    __i18n_refs?: {
+        _key: string;
+        lang: string;
+        ref: {
+            _type: 'reference';
+            _ref: string;
+            _weak: boolean;
+        };
+    }[];
+};

package/lib/types/Ti18nSchema.d.ts

@@ -0,0 +1,5 @@
+import { TSchema } from './TSchema';
+import { Ti18nConfig } from './Ti18nConfig';
+export declare type Ti18nSchema = TSchema<{
+    i18n: boolean | Ti18nConfig;
+}>;

package/lib/types/index.d.ts

@@ -0,0 +1,14 @@
+export * from './ILanguageObject';
+export * from './ILanguageQuery';
+export * from './IType';
+export * from './TLanguage';
+export * from './IResolverProps';
+export * from './TLanguagesOption';
+export * from './TSchema';
+export * from './Ti18nSchema';
+export * from './Ti18nConfig';
+export * from './Ti18nDocument';
+export * from './TFieldNamesConfig';
+export * from './IUseDocumentOperationResult';
+export * from './ITranslationRef';
+export * from './IEditState';

package/lib/utils/baseToTop.d.ts

@@ -0,0 +1 @@
+export declare const baseToTop: (a: any, b: any) => number;

package/lib/utils/batch.d.ts

@@ -0,0 +1 @@
+export declare function batch<R>(input: R[], fn: (input: R[]) => Promise<void>): Promise<void>;

package/lib/utils/buildDocId.d.ts

@@ -0,0 +1 @@
+export declare const buildDocId: (id: string, lang: string | null) => string;

package/lib/utils/createSanityReference.d.ts

@@ -0,0 +1,5 @@
+export declare function createSanityReference(id: string, weak?: boolean, strengthen?: boolean): {
+    _weak?: boolean;
+    _type: "reference";
+    _ref: string;
+};

package/lib/utils/getAllSchemas.d.ts

@@ -0,0 +1,2 @@
+import { TSchema } from '../types';
+export declare const getAllSchemas: () => TSchema[];

package/lib/utils/getBaseIdFromId.d.ts

@@ -0,0 +1 @@
+export declare const getBaseIdFromId: (id: string) => string;

package/lib/utils/getBaseLanguage.d.ts

@@ -0,0 +1,2 @@
+import { ILanguageObject } from '../types';
+export declare const getBaseLanguage: (langs: ILanguageObject[], base?: string | undefined) => ILanguageObject | null;

package/lib/utils/getConfig.d.ts

@@ -0,0 +1,6 @@
+import { Ti18nSchema, Ti18nConfig } from '../types';
+export declare function getConfig(type?: string | Ti18nSchema): Required<{
+    [K in keyof Ti18nConfig]: Required<Ti18nConfig[K]>;
+}> & {
+    withTranslationsMaintenance: boolean;
+};

package/lib/utils/getFlag.d.ts

@@ -0,0 +1,2 @@
+export declare const getFlag: (code?: string) => string;
+export declare const getFlagCode: (code?: string) => string;

package/lib/utils/getLanguageFromId.d.ts

@@ -0,0 +1 @@
+export declare const getLanguageFromId: (id: string) => string | null;

package/lib/utils/getLanguagesFromOption.d.ts

@@ -0,0 +1,3 @@
+import type { SanityDocument } from '@sanity/client';
+import { ILanguageObject, TLanguagesOption } from '../types';
+export declare const getLanguagesFromOption: <D extends SanityDocument<Record<string, any>>>(langs: TLanguagesOption, document?: D | null | undefined) => Promise<ILanguageObject[]>;

package/lib/utils/getSanityClient.d.ts

@@ -0,0 +1 @@
+export declare const getSanityClient: () => import('@sanity/client').SanityClient;

package/lib/utils/getSchema.d.ts

@@ -0,0 +1,2 @@
+import { TSchema } from '../types';
+export declare const getSchema: <T = any>(name: string) => TSchema<T>;

package/lib/utils/getTranslationsForId.d.ts

@@ -0,0 +1,2 @@
+import { SanityDocument } from '@sanity/client';
+export declare const getTranslationsFor: (baseDocumentId: string) => Promise<SanityDocument<Record<string, any>>[]>;

package/lib/utils/index.d.ts

@@ -0,0 +1,16 @@
+export * from './getConfig';
+export * from './buildDocId';
+export * from './normalizeLanguageList';
+export * from './getBaseLanguage';
+export * from './getSanityClient';
+export * from './getLanguagesFromOption';
+export * from './getSchema';
+export * from './getLanguageFromId';
+export * from './getBaseIdFromId';
+export * from './getAllSchemas';
+export * from './getTranslationsForId';
+export * from './makeObjectKey';
+export * from './createSanityReference';
+export * from './updateIntlFieldsForDocument';
+export * from './serializePath';
+export * from './batch';