@tinacms/schema-tools 0.0.0-00f6525-20241015065741

package/dist/schema/TinaSchema.d.ts

@@ -0,0 +1,81 @@
+import type { Schema, Collection, Template, Collectable, CollectionTemplateable, TinaField } from '../types/index';
+type Version = {
+    fullVersion: string;
+    major: string;
+    minor: string;
+    patch: string;
+};
+type Meta = {
+    flags?: string[];
+};
+/**
+ * TinaSchema is responsible for allowing you to look up certain
+ * properties of the user-provided schema with ease.
+ *
+ */
+export declare class TinaSchema {
+    config: {
+        version?: Version;
+        meta?: Meta;
+    } & Schema;
+    schema: Schema<true>;
+    /**
+     * Create a schema class from a user defined schema object
+     */
+    constructor(config: {
+        version?: Version;
+        meta?: Meta;
+    } & Schema);
+    getIsTitleFieldName: (collection: string) => string;
+    getCollectionsByName: (collectionNames: string[]) => Collection<true>[];
+    getCollection: (collectionName: string) => Collection<true>;
+    getCollections: () => Collection<true>[];
+    getCollectionByFullPath: (filepath: string) => Collection<true>;
+    getCollectionAndTemplateByFullPath: (filepath: string, templateName?: string) => {
+        collection: Collection<true>;
+        template: Template<true>;
+    } | undefined;
+    getTemplateForData: ({ data, collection, }: {
+        data?: unknown;
+        collection: Collectable;
+    }) => Template<true>;
+    transformPayload: (collectionName: string, payload: object) => {
+        [x: string]: {
+            [key: string]: unknown;
+        };
+    };
+    private transformCollectablePayload;
+    private transformField;
+    isMarkdownCollection: (collectionName: string) => boolean;
+    /**
+     * Gets the template or templates from the item.
+     * Both `object` fields and collections support
+     * the ability for an object to be polymorphic,
+     * and if it is, we need to build unions, which
+     * are more of a headache for non-polymorphic
+     * needs, so we also need the ability to just
+     * build object types
+     *
+     *
+     */
+    getTemplatesForCollectable: (collection: Collectable) => CollectionTemplateable;
+    walkFields: (cb: (args: {
+        field: TinaField;
+        collection: Collection;
+        path: string[];
+    }) => void) => void;
+    /**
+     * This function returns an array of glob matches for a given collection.
+     *
+     * @param collection The collection to get the matches for. Can be a string or a collection object.
+     * @returns An array of glob matches.
+     */
+    getMatches({ collection: collectionOrString, }: {
+        collection: string | Collection;
+    }): string[];
+    matchFiles({ collection, files, }: {
+        collection: string | Collection;
+        files: string[];
+    }): string[];
+}
+export {};

package/dist/schema/addNamespaceToSchema.d.ts

@@ -0,0 +1,4 @@
+/**
+
+*/
+export declare function addNamespaceToSchema<T extends object | string>(maybeNode: T, namespace?: string[]): T;

package/dist/schema/index.d.ts

@@ -0,0 +1,7 @@
+/**
+
+*/
+export * from './addNamespaceToSchema';
+export * from './TinaSchema';
+export * from './resolveField';
+export * from './resolveForm';

package/dist/schema/resolveField.d.ts

@@ -0,0 +1,14 @@
+/**
+
+*/
+import type { TinaField } from '../types/index';
+import type { TinaSchema } from './TinaSchema';
+/**
+ * Turns a field the schema (schema.{js,ts} file) into a valid front end FieldConfig
+ */
+export declare const resolveField: (field: TinaField<true>, schema: TinaSchema) => {
+    [key: string]: unknown;
+    name: string;
+    component: NonNullable<TinaField<true>["ui"]>["component"];
+    type: string;
+};

package/dist/schema/resolveForm.d.ts

@@ -0,0 +1,26 @@
+/**
+
+*/
+import type { Template, Collection } from '../types/index';
+import type { TinaSchema } from './TinaSchema';
+/**
+ *  Given a collection, basename, template and schema. This will transform the given information into a valid frontend form config
+ */
+export declare const resolveForm: ({ collection, basename, template, schema, }: ResolveFormArgs) => {
+    id: string;
+    label: string;
+    name: string;
+    fields: {
+        [key: string]: unknown;
+        name: string;
+        component: NonNullable<import("../types/index").TinaField<true>["ui"]>["component"];
+        type: string;
+    }[];
+};
+type ResolveFormArgs = {
+    collection: Collection<true>;
+    basename: string;
+    template: Template<true>;
+    schema: TinaSchema;
+};
+export {};