@tinacms/schema-tools 0.0.1 → 0.0.2

package/CHANGELOG.md

@@ -0,0 +1,33 @@
+# @tinacms/schema-tools
+
+## 0.0.2
+### Patch Changes
+
+- abf25c673: The schema can now to used on the frontend (optional for now but will be the main path moving forward).
+  
+  ### How to migrate.
+  
+  If you gone though the `tinacms init` process there should be a file called `.tina/components/TinaProvider`. In that file you can import the schema from `schema.ts` and add it to the TinaCMS wrapper component.
+  
+  ```tsx
+  import TinaCMS from 'tinacms'
+  import schema, { tinaConfig } from '../schema.ts'
+  
+  // Importing the TinaProvider directly into your page will cause Tina to be added to the production bundle.
+  // Instead, import the tina/provider/index default export to have it dynamially imported in edit-moode
+  /**
+   *
+   * @private Do not import this directly, please import the dynamic provider instead
+   */
+  const TinaProvider = ({ children }) => {
+    return (
+      <TinaCMS {...tinaConfig} schema={schema}>
+        {children}
+      </TinaCMS>
+    )
+  }
+  
+  export default TinaProvider
+  ```
+- 801f39f62: Update types
+- e8b0de1f7: Add `parentTypename` to fields to allow us to disambiguate between fields which have the same field names but different types. Example, an event from field name of `blocks.0.title` could belong to a `Cta` block or a `Hero` block, both of which have a `title` field.

package/dist/index.js

@@ -319,6 +319,7 @@ var TinaSchema = class {
 var resolveField = (_a, schema) => {
   var _b = _a, { namespace } = _b, field = __objRest(_b, ["namespace"]);
   var _a2;
+  field.parentTypename = NAMER.dataTypeName(namespace.filter((_, i) => i < namespace.length - 1));
   const extraFields = field.ui || {};
   switch (field.type) {
     case "number":

package/dist/types/SchemaTypes.d.ts

@@ -61,18 +61,24 @@ export interface CollectionTemplatesWithNamespace<WithNamespace extends boolean>
 }
 declare type CollectionFields<WithNamespace extends boolean> = WithNamespace extends true ? CollectionFieldsWithNamespace<WithNamespace> : CollectionFieldsInner<WithNamespace>;
 export interface CollectionFieldsWithNamespace<WithNamespace extends boolean> extends BaseCollection {
-    fields: string | TinaFieldInner<WithNamespace>[];
+    fields: TinaFieldInner<WithNamespace>[];
     templates?: undefined;
     references?: ReferenceType<WithNamespace>[];
     namespace: string[];
 }
 interface CollectionFieldsInner<WithNamespace extends boolean> extends BaseCollection {
-    fields: string | TinaFieldInner<WithNamespace>[];
+    fields: TinaFieldInner<WithNamespace>[];
     templates?: undefined;
 }
 export declare type TinaFieldInner<WithNamespace extends boolean> = ScalarType<WithNamespace> | ObjectType<WithNamespace> | ReferenceType<WithNamespace> | RichType<WithNamespace>;
 export declare type TinaFieldBase = TinaFieldInner<false>;
-export declare type TinaFieldEnriched = TinaFieldInner<true>;
+export declare type TinaFieldEnriched = TinaFieldInner<true> & {
+    /**
+     * The parentTypename will always be an object type, either the type of a
+     * collection (ie. `Post`) or of an object field (ie. `PageBlocks`).
+     */
+    parentTypename?: string;
+};
 interface TinaField {
     name: string;
     label?: string;
@@ -83,7 +89,7 @@ interface TinaField {
      * NOTE: only serializable values are supported, so functions like `validate`
      * will be ignored.
      */
-    ui?: object;
+    ui?: Record<string, any>;
 }
 declare type ScalarType<WithNamespace extends boolean> = WithNamespace extends true ? ScalarTypeWithNamespace : ScalarTypeInner;
 declare type Option = string | {
@@ -159,6 +165,7 @@ export interface ReferenceTypeInner extends TinaField {
         name: string;
     };
     collections: string[];
+    ui?: UIField<any, string[]>;
 }
 export interface ReferenceTypeWithNamespace extends TinaField {
     type: 'reference';
@@ -169,6 +176,7 @@ export interface ReferenceTypeWithNamespace extends TinaField {
         name: string;
     };
     namespace: string[];
+    ui?: UIField<any, string[]>;
 }
 export interface RichTypeWithNamespace extends TinaField {
     type: 'rich-text';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinacms/schema-tools",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "files": [