tinacms 0.66.9 → 0.66.10

package/CHANGELOG.md

@@ -1,5 +1,63 @@
 # tinacms
 
+## 0.66.10
+
+### Patch Changes
+
+- 39a8c4f7d: Fix issue with unstableFormify where `Document` interface fields were not being formified properly
+- ec28a129b: Update to tina admin to use the frontend schema
+- a28b787c5: With the rich-text editor, inserting a soft-break (`shift+enter`), this will now result in a `<br>` tag being inserted. Note that this will save the markdown with a backslash to indicate line break (instead of multiple empty spaces):
+
+  ```markdown
+  123 Abc St\
+  Charlottetown, PEI
+  ```
+
+- 93363dfc2: Prevent error on reset when nested blocks have changed in unstable formify hook
+- 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
+  ```
+
+- 591640db0: Fixes a bug with `breadcrumbs` to account for subfolders (instead of just the `filename`) and allows Documents to be created and updated within subfolders.
+
+  Before this fix, `breadcrumbs` was only the `basename` of the file minus the `extension`. So `my-folder-a/my-folder-b/my-file.md` would have `breadcrumbs` of `['my-file']`. With this change, `breadcrumbs` will be `['my-folder-a','my-folder-b','my-file']` (leaving out the `content/<collection>`).
+
+- 875779ac6: Don't attempt to formify nodes which don't have data fields (ie. ...on Node)
+- 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.
+- Updated dependencies [429d8e93e]
+- Updated dependencies [6c517b5da]
+- Updated dependencies [e81cf8867]
+- Updated dependencies [abf25c673]
+- Updated dependencies [801f39f62]
+- Updated dependencies [0e270d878]
+- Updated dependencies [e8b0de1f7]
+  - @tinacms/sharedctx@0.1.1
+  - @tinacms/toolkit@0.56.19
+  - @tinacms/schema-tools@0.0.2
+
 ## 0.66.9
 
 ### Patch Changes

package/dist/client/index.d.ts

@@ -14,12 +14,14 @@ import { TokenObject } from '../auth/authenticate';
 import { BranchData, EventBus } from '@tinacms/toolkit';
 import { DocumentNode, GraphQLSchema } from 'graphql';
 import gql from 'graphql-tag';
+import { TinaSchema, TinaCloudSchema } from '@tinacms/schema-tools';
 export declare type TinaIOConfig = {
     frontendUrlOverride?: string;
     identityApiUrlOverride?: string;
     contentApiUrlOverride?: string;
 };
 interface ServerOptions {
+    schema?: TinaCloudSchema<false>;
     clientId: string;
     branch: string;
     customContentApiUrl?: string;
@@ -31,7 +33,8 @@ export declare class Client {
     frontendUrl: string;
     contentApiUrl: string;
     identityApiUrl: string;
-    schema: GraphQLSchema;
+    gqlSchema: GraphQLSchema;
+    schema?: TinaSchema;
     clientId: string;
     contentApiBase: string;
     query: string;
@@ -103,6 +106,7 @@ export declare const DEFAULT_LOCAL_TINA_GQL_SERVER_URL = "http://localhost:4001/
 export declare class LocalClient extends Client {
     constructor(props?: {
         customContentApiUrl?: string;
+        schema?: TinaCloudSchema<false>;
     });
     isAuthorized(): Promise<boolean>;
     isAuthenticated(): Promise<boolean>;

package/dist/hooks/formify/formify-utils.d.ts

@@ -0,0 +1,89 @@
+/**
+Copyright 2021 Forestry.io Holdings, Inc.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+import * as G from 'graphql';
+import type { BlueprintPath } from './types';
+/**
+ *
+ * This check ensures that at type is a Document, but only one
+ * that can be "formified". When using `Node` or `Document`, those
+ * query fields should not have forms generated since they can't contain
+ * fields.
+ *
+ * ```graphql
+ * # Can be formified
+ * {
+ *   getPostDocument(relativePath: "") {
+ *     data {
+ *       title
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ```graphql
+ * # cannot be formified, even though it is a document field
+ * {
+ *   getPostDocument(relativePath: "") {
+ *     ...on Document {
+ *       id
+ *     }
+ *   }
+ * }
+ * ```
+ */
+export declare const isFormifiableDocument: (t: G.GraphQLOutputType) => boolean;
+export declare const isScalarType: (t: G.GraphQLOutputType) => boolean;
+export declare const isConnectionField: (t: G.GraphQLOutputType) => boolean;
+/**
+ * Selects the appropriate field from a GraphQLObject based on the selection's name
+ */
+export declare const getObjectField: (object: G.GraphQLOutputType, selectionNode: G.FieldNode) => G.GraphQLField<any, any, {
+    [key: string]: any;
+}>;
+/**
+ * Selects the appropriate type from a union based on the selection's typeCondition
+ *
+ * ```graphql
+ * post {
+ *    # would return PostDocument
+ *   ...on PostDocument { ... }
+ * }
+ * ```
+ */
+export declare const getSelectedUnionType: (unionType: G.GraphQLOutputType, selectionNode: G.InlineFragmentNode) => any;
+/**
+ * Checks if the given type is a list type. Even though
+ * this function is built-in to GraphQL it doesn't handle
+ * the scenario where the list type is wrapped in a non-null
+ * type, so the extra check here is needed.
+ */
+export declare function isListType(type: unknown): boolean;
+/**
+ *
+ * Throws an error if the provided type is not a GraphQLUnionType
+ */
+export declare function ensureOperationDefinition(type: G.DefinitionNode): asserts type is G.OperationDefinitionNode;
+/**
+ * Generates the name and alias information for a given field node
+ * and appends it to a shallow copy of the path provided
+ */
+export declare function buildPath({ fieldNode, type, parentTypename, path, }: {
+    fieldNode: G.FieldNode;
+    type: G.GraphQLOutputType;
+    parentTypename?: string;
+    path?: BlueprintPath[];
+}): BlueprintPath[];
+export declare const metaFields: G.SelectionNode[];
+export declare const getRelativeBlueprint: (path: BlueprintPath[]) => string;
+export declare const getBlueprintId: (path: BlueprintPath[]) => string;
+export declare const getFieldAliasForBlueprint: (path: BlueprintPath[]) => string;

package/dist/hooks/formify/reducer.d.ts

@@ -17,6 +17,7 @@ export declare const buildChangeSet: (event: OnChangeEvent, formNode: FormNode)
         name: string;
         type: "string" | "object" | "reference";
         list?: boolean;
+        parentTypename: string;
     };
     name: string;
     formId: string;

package/dist/hooks/formify/{test → spec}/runner.d.ts

@@ -10,4 +10,4 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
-export declare const testRunner: (query: any, events: any, dirname: any) => Promise<void>;
+export declare const testRunner: (query: any, events: any, dirname: any, expectNoChange?: boolean) => Promise<void>;

package/dist/hooks/formify/types.d.ts

@@ -14,6 +14,11 @@ limitations under the License.
 import type * as G from 'graphql';
 import type { Form, Field } from '@tinacms/toolkit';
 export declare type Action = {
+    type: 'start';
+    value: {
+        query: string;
+    };
+} | {
     type: 'setData';
     value: object;
 } | {
@@ -53,9 +58,9 @@ export declare type FormifiedDocumentNode = {
     id: string;
     _internalSys: {
         path: string;
-    };
-    collection: {
-        name: any;
+        collection: {
+            name: any;
+        };
     };
     form: {
         mutationInfo: {
@@ -106,6 +111,7 @@ export declare type OnChangeEvent = {
                 name: string;
                 type: 'string' | 'reference' | 'object';
                 list?: boolean;
+                parentTypename: string;
             };
         };
         name: string;
@@ -128,6 +134,7 @@ export declare type ChangeSet = {
 export declare type BlueprintPath = {
     name: string;
     alias: string;
+    parentTypename?: string;
     list?: boolean;
     isNode?: boolean;
 };
@@ -165,7 +172,7 @@ export declare type State = {
     schema: G.GraphQLSchema;
     query: G.DocumentNode;
     queryString: string;
-    status: 'initialized' | 'formified' | 'ready' | 'done';
+    status: 'idle' | 'initialized' | 'formified' | 'ready' | 'done';
     count: number;
     data: object;
     changeSets: ChangeSet[];

package/dist/hooks/formify/util.d.ts

@@ -10,75 +10,32 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
-import * as G from 'graphql';
 import { Form, Field, TinaCMS } from '@tinacms/toolkit';
-import type { DocumentBlueprint, FieldBlueprint, BlueprintPath, FormifiedDocumentNode, OnChangeEvent, FormNode, State, ChangeSet } from './types';
+import type { DocumentBlueprint, FieldBlueprint, FormifiedDocumentNode, OnChangeEvent, FormNode, State, ChangeSet, BlueprintPath } from './types';
 import { formifyCallback, onSubmitArgs } from '../use-graphql-forms';
 interface RecursiveFormifiedDocumentNode<T extends object> extends Array<RecursiveFormifiedDocumentNode<T> | T> {
 }
-export declare const isNodeField: (type: G.GraphQLNamedType) => boolean;
-export declare const isConnectionField: (type: G.GraphQLNamedType) => boolean;
 /**
- * Selects the appropriate field from a GraphQLObject based on the selection's name
- */
-export declare const getObjectField: (object: G.GraphQLObjectType<any, any>, selectionNode: G.FieldNode) => G.GraphQLField<any, any, {
-    [key: string]: any;
-}>;
-/**
- * Selects the appropriate type from a union based on the selection's typeCondition
- *
- * ```graphql
- * post {
- *    # would return PostDocument
- *   ...on PostDocument { ... }
+ * Gets the value from an object for a given blueprint for _all_ possible values.
+ * eg. If the blueprint is `getCollection.documents.edges.[].node` and the value is:
+ * ```
+ * {
+ *   getCollection: {
+ *      documents: {
+ *        edges: [{
+ *          node: valueA
+ *        },
+ *        {
+ *          node: valueB
+ *        }]
+ *      }
+ *   }
  * }
  * ```
- */
-export declare const getSelectedUnionType: (unionType: G.GraphQLUnionType, selectionNode: G.InlineFragmentNode) => G.GraphQLObjectType<any, any>;
-/**
- * Checks if the given type is a list type. Even though
- * this function is built-in to GraphQL it doesn't handle
- * the scenario where the list type is wrapped in a non-null
- * type, so the extra check here is needed.
- */
-export declare function isListType(type: unknown): boolean;
-/**
- *
- * Throws an error if the provided type is no a GraphQLUnionType
- */
-export declare function ensureNodeField(field: G.GraphQLNamedType): void;
-/**
- *
- * Throws an error if the provided type is no a GraphQLUnionType
- */
-export declare function ensureUnionType(type: unknown): asserts type is G.GraphQLUnionType;
-/**
- *
- * Throws an error if the provided type is no a GraphQLUnionType
- */
-export declare function ensureObjectType(type: unknown): asserts type is G.GraphQLObjectType;
-/**
+ * The response would be an array containing `valueA` and `valueB`
  *
- * Throws an error if the provided type is no a GraphQLUnionType
  */
-export declare function ensureOperationDefinition(type: G.DefinitionNode): asserts type is G.OperationDefinitionNode;
-export declare function getNameAndAlias(fieldNode: G.FieldNode, list: boolean, isNode: boolean): {
-    name: string;
-    alias: string;
-    list: boolean;
-    isNode: boolean;
-};
-export declare const metaFields: G.SelectionNode[];
-export declare const getRelativeBlueprint: (path: BlueprintPath[]) => string;
-export declare const getFieldAliasForBlueprint: (path: BlueprintPath[]) => string;
-/**
- *
- *
- * ./index utilities
- *
- *
- */
-export declare const getIn2: <T extends object>(state: object, path: string) => T | RecursiveFormifiedDocumentNode<T>;
+export declare const getValueForBlueprint: <T extends object>(state: object, path: string) => T | RecursiveFormifiedDocumentNode<T>;
 /**
  * Returns the name of the field. In the example query, `title` and `t` would both be blueprint fields
  *
@@ -99,25 +56,52 @@ export declare const formNodeId: (formNode: FormNode) => string;
 export declare const formNodePath: (formNode: FormNode) => string;
 export declare const formNodeNotIn: (formNode: FormNode, formNodes: FormNode[]) => boolean;
 export declare const sequential: <A, B>(items: A[], callback: (args: A, idx: number) => Promise<B>) => Promise<B[]>;
-export declare const getBlueprintId: (path: BlueprintPath[]) => string;
 export declare const getFormNodesForField: (fieldBlueprint: FieldBlueprint, formNode: FormNode, event: OnChangeEvent, state: State) => {
     pathToChange: string;
     formNodes: FormNode[];
     eventLocation: any[];
     existing: any;
 };
-export declare const matchLocation: (eventLocation: number[], formNode: FormNode) => boolean;
-export declare const bumpLocation: (location: number[]) => number[];
-export declare const maybeLowerLocation: (location: number[], at: number) => number[];
-export declare const matchesAt: (location: number[], at: number) => boolean;
-export declare const swapLocation: (location: number[], mapping: {
-    [key: number]: number;
-}) => number[];
 export declare const getBlueprintAliasPath: (blueprint: DocumentBlueprint) => string;
+export declare const getFieldAliasForBlueprint: (path: BlueprintPath[]) => string;
+/**
+ *
+ * Determines the appropriate fields which should recieve an update from a form change
+ *
+ * In cases where there's polymorphic blocks, it's possible that an update would affect
+ * multiple locations that it shouldn't.
+ *
+ * An OnChange event name can look like: `blocks.2.title`, but if there are 2 block elements
+ * with a field of the same name, an event name it wouldn't be enough information for us.
+ *
+ * To get around this, the event sends the current `typename` along with it, and we use that
+ * to determine where in our blueprint the value should be updated.
+ *
+ */
 export declare const getBlueprintFieldsForEvent: (blueprint: DocumentBlueprint, event: OnChangeEvent) => FieldBlueprint[];
-export declare const getBlueprintNamePath: (blueprint: Pick<DocumentBlueprint, 'path'>) => string;
+export declare const filterFieldBlueprintsByParentTypename: (fbp: FieldBlueprint, typename: any) => boolean;
+/**
+ *
+ * Returns the human-readable path to a blueprint or blueprint field.
+ * Optionally, appends a disambiguator to the string where necessary.
+ *
+ * eg. if a blocks field is polymporphic, specifying `true` for the disambiguator
+ *
+ * ```
+ * getPageDocument.data.blocks[].PageBlocksCta.title
+ * ```
+ */
+export declare const getBlueprintNamePath: (blueprint: Pick<DocumentBlueprint, 'path'>, disambiguator?: boolean) => string;
 export declare const stripIndices: (string: any) => any[];
 export declare const replaceRealNum: (string: any) => any;
+export declare const getMatchName: ({ field, prefix, blueprint }: {
+    field: any;
+    prefix: any;
+    blueprint: any;
+}) => {
+    matchName: string;
+    fieldName: any;
+};
 export declare const getFormNodesFromEvent: (state: State, event: OnChangeEvent) => FormNode[];
 export declare const printState: (state: State) => string;
 export declare const printEvent: (event: OnChangeEvent) => {
@@ -132,6 +116,7 @@ export declare const printEvent: (event: OnChangeEvent) => {
                 name: string;
                 type: "string" | "object" | "reference";
                 list?: boolean;
+                parentTypename: string;
             };
         };
         name: string;
@@ -141,10 +126,13 @@ export declare const getFormNodeBlueprint: (formNode: FormNode, state: State) =>
 export declare const getMoveMapping: (existing: any, from: any, to: any) => {
     [key: number]: number;
 };
-export declare const getPathsToChange: (event: OnChangeEvent, state: State) => {
-    formNode: FormNode;
-    pathToChange: string;
-}[];
+export declare const matchLocation: (eventLocation: number[], formNode: FormNode) => boolean;
+export declare const bumpLocation: (location: number[]) => number[];
+export declare const maybeLowerLocation: (location: number[], at: number) => number[];
+export declare const matchesAt: (location: number[], at: number) => boolean;
+export declare const swapLocation: (location: number[], mapping: {
+    [key: number]: number;
+}) => number[];
 /**
  *
  * Gets the sub-fields for an object field, if it's a polymorphic

package/dist/hooks/use-graphql-forms.d.ts

@@ -10,7 +10,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
-import { Form } from '@tinacms/toolkit';
+import { Form, AnyField } from '@tinacms/toolkit';
 import type { FormOptions, TinaCMS } from '@tinacms/toolkit';
 export declare function useGraphqlFormsUnstable<T extends object>({ variables, onSubmit, query, formify, eventList, }: {
     query: string;
@@ -40,7 +40,7 @@ export declare const transformDocumentIntoMutationRequestPayload: (document: {
     includeTemplate?: boolean;
 }) => any;
 export declare const generateFormCreatorsUnstable: (cms: TinaCMS, showInSidebar?: boolean) => {
-    createForm: (formConfig: any) => Form<any, import("@tinacms/toolkit").AnyField>;
+    createForm: (formConfig: any) => Form<any, AnyField>;
     createGlobalForm: GlobalFormCreator;
 };
 declare type FormCreator = (formConfig: FormOptions<any>) => Form;

package/dist/index.d.ts

@@ -23,9 +23,8 @@ export { TinaAdminApi } from './admin/api';
 import { TinaCMSProvider2, TinaCMSProviderDefaultProps } from './tina-cms';
 export type { TinaCMSProviderDefaultProps };
 export default TinaCMSProvider2;
-import type { TinaCloudSchema as TinaCloudSchemaBase, TinaCloudCollection as TinaCloudCollectionBase, TinaCloudTemplateBase as TinaTemplate, TinaFieldBase } from './types';
+import type { TinaCloudSchema as TinaCloudSchemaBase, TinaCloudCollection as TinaCloudCollectionBase, TinaCloudTemplateBase as TinaTemplate, TinaFieldBase } from '@tinacms/schema-tools';
 export declare type TinaCloudSchema = TinaCloudSchemaBase<false>;
-export declare type TinaSchema = TinaCloudSchema;
 export declare type TinaCloudCollection = TinaCloudCollectionBase<false>;
 export declare type TinaCollection = TinaCloudCollectionBase<false>;
 export declare type TinaField = TinaFieldBase;