@tinacms/schema-tools 0.0.4 → 0.0.7

package/dist/types/SchemaTypes.d.ts

@@ -21,9 +21,19 @@ export declare type UIField<F extends UIField = any, Shape = any> = {
     validate?(value: Shape, allValues: any, meta: any, field: UIField<F, Shape>): string | object | undefined | void;
     defaultValue?: Shape;
 };
-export interface TinaCloudSchema<WithNamespace extends boolean> {
+export interface TinaCloudSchemaConfig<Store = any> {
+    media?: {
+        loadCustomStore?: () => Promise<Store>;
+        tina?: {
+            publicFolder: string;
+            mediaRoot: string;
+        };
+    };
+}
+export interface TinaCloudSchema<WithNamespace extends boolean, Store = any> {
     templates?: GlobalTemplate<WithNamespace>[];
     collections: TinaCloudCollection<WithNamespace>[];
+    config?: TinaCloudSchemaConfig<Store>;
 }
 export declare type TinaCloudSchemaBase = TinaCloudSchema<false>;
 export declare type TinaCloudSchemaEnriched = TinaCloudSchema<true>;
@@ -35,6 +45,7 @@ export declare type TinaCloudSchemaEnriched = TinaCloudSchema<true>;
 export interface TinaCloudSchemaWithNamespace {
     templates?: GlobalTemplate<true>[];
     collections: TinaCloudCollection<true>[];
+    config?: TinaCloudSchemaConfig;
     namespace: string[];
 }
 export declare type TinaCloudCollection<WithNamespace extends boolean> = CollectionFields<WithNamespace> | CollectionTemplates<WithNamespace>;

package/dist/validate/index.d.ts

@@ -11,6 +11,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 import { TinaCloudSchema } from '../types';
+export { validateTinaCloudSchemaConfig } from './tinaCloudSchemaConfig';
 export declare class TinaSchemaValidationError extends Error {
     constructor(message: any);
 }

package/dist/validate/schema.d.ts

@@ -88,6 +88,49 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         format?: "json" | "md" | "markdown" | "mdx";
         label?: string;
     }>, "many">;
+    config: z.ZodOptional<z.ZodObject<{
+        media: z.ZodOptional<z.ZodObject<{
+            tina: z.ZodOptional<z.ZodObject<{
+                publicFolder: z.ZodString;
+                mediaRoot: z.ZodString;
+            }, "strict", z.ZodTypeAny, {
+                publicFolder?: string;
+                mediaRoot?: string;
+            }, {
+                publicFolder?: string;
+                mediaRoot?: string;
+            }>>;
+            loadCustomStore: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnknown>>;
+        }, "strip", z.ZodTypeAny, {
+            tina?: {
+                publicFolder?: string;
+                mediaRoot?: string;
+            };
+            loadCustomStore?: (...args: unknown[]) => unknown;
+        }, {
+            tina?: {
+                publicFolder?: string;
+                mediaRoot?: string;
+            };
+            loadCustomStore?: (...args: unknown[]) => unknown;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        media?: {
+            tina?: {
+                publicFolder?: string;
+                mediaRoot?: string;
+            };
+            loadCustomStore?: (...args: unknown[]) => unknown;
+        };
+    }, {
+        media?: {
+            tina?: {
+                publicFolder?: string;
+                mediaRoot?: string;
+            };
+            loadCustomStore?: (...args: unknown[]) => unknown;
+        };
+    }>>;
 }, "strip", z.ZodTypeAny, {
     collections?: {
         name?: string;
@@ -100,6 +143,15 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         format?: "json" | "md" | "markdown" | "mdx";
         label?: string;
     }[];
+    config?: {
+        media?: {
+            tina?: {
+                publicFolder?: string;
+                mediaRoot?: string;
+            };
+            loadCustomStore?: (...args: unknown[]) => unknown;
+        };
+    };
 }, {
     collections?: {
         name?: string;
@@ -112,6 +164,15 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         format?: "json" | "md" | "markdown" | "mdx";
         label?: string;
     }[];
+    config?: {
+        media?: {
+            tina?: {
+                publicFolder?: string;
+                mediaRoot?: string;
+            };
+            loadCustomStore?: (...args: unknown[]) => unknown;
+        };
+    };
 }>, {
     collections?: {
         name?: string;
@@ -124,6 +185,15 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         format?: "json" | "md" | "markdown" | "mdx";
         label?: string;
     }[];
+    config?: {
+        media?: {
+            tina?: {
+                publicFolder?: string;
+                mediaRoot?: string;
+            };
+            loadCustomStore?: (...args: unknown[]) => unknown;
+        };
+    };
 }, {
     collections?: {
         name?: string;
@@ -136,4 +206,13 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         format?: "json" | "md" | "markdown" | "mdx";
         label?: string;
     }[];
+    config?: {
+        media?: {
+            tina?: {
+                publicFolder?: string;
+                mediaRoot?: string;
+            };
+            loadCustomStore?: (...args: unknown[]) => unknown;
+        };
+    };
 }>;

package/dist/validate/tinaCloudSchemaConfig.d.ts

@@ -0,0 +1,58 @@
+/**
+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 { TinaCloudSchemaConfig } from '../types';
+import z from 'zod';
+export declare const tinaConfigZod: z.ZodObject<{
+    media: z.ZodOptional<z.ZodObject<{
+        tina: z.ZodOptional<z.ZodObject<{
+            publicFolder: z.ZodString;
+            mediaRoot: z.ZodString;
+        }, "strict", z.ZodTypeAny, {
+            publicFolder?: string;
+            mediaRoot?: string;
+        }, {
+            publicFolder?: string;
+            mediaRoot?: string;
+        }>>;
+        loadCustomStore: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnknown>>;
+    }, "strip", z.ZodTypeAny, {
+        tina?: {
+            publicFolder?: string;
+            mediaRoot?: string;
+        };
+        loadCustomStore?: (...args: unknown[]) => unknown;
+    }, {
+        tina?: {
+            publicFolder?: string;
+            mediaRoot?: string;
+        };
+        loadCustomStore?: (...args: unknown[]) => unknown;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    media?: {
+        tina?: {
+            publicFolder?: string;
+            mediaRoot?: string;
+        };
+        loadCustomStore?: (...args: unknown[]) => unknown;
+    };
+}, {
+    media?: {
+        tina?: {
+            publicFolder?: string;
+            mediaRoot?: string;
+        };
+        loadCustomStore?: (...args: unknown[]) => unknown;
+    };
+}>;
+export declare const validateTinaCloudSchemaConfig: (config: unknown) => TinaCloudSchemaConfig;

package/package.json

@@ -1,7 +1,15 @@
 {
   "name": "@tinacms/schema-tools",
-  "version": "0.0.4",
+  "version": "0.0.7",
   "main": "dist/index.js",
+  "module": "./dist/index.es.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.es.js",
+      "require": "./dist/index.js"
+    }
+  },
   "typings": "dist/index.d.ts",
   "files": [
     "dist"
@@ -10,30 +18,22 @@
   "buildConfig": {
     "entryPoints": [
       {
-        "name": "src/index.ts",
-        "target": "node"
+        "name": "src/index.ts"
       }
     ]
   },
   "devDependencies": {
-    "@tinacms/scripts": "0.50.7",
+    "@tinacms/scripts": "0.50.9",
     "@types/yup": "^0.29.10",
     "jest": "^27.0.6",
-    "react": "16.14.0",
-    "typescript": "^4.3.5",
+    "react": "17.0.2",
+    "typescript": "4.3.5",
     "yup": "^0.32.0"
   },
   "peerDependencies": {
     "react": ">=16.14.0",
     "yup": "^0.32.0"
   },
-  "scripts": {
-    "build": "echo \"Run `yarn build` from the root of the repository instead\"",
-    "test": "jest --passWithNoTests",
-    "types": "yarn tsc",
-    "test-watch": "jest  --passWithNoTests --watch",
-    "generate:schema": "yarn node scripts/generateSchema.js"
-  },
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
   },
@@ -43,5 +43,12 @@
   },
   "dependencies": {
     "zod": "^3.14.3"
+  },
+  "scripts": {
+    "build": "tinacms-scripts build",
+    "test": "jest --passWithNoTests",
+    "types": "pnpm tsc",
+    "test-watch": "jest  --passWithNoTests --watch",
+    "generate:schema": "yarn node scripts/generateSchema.js"
   }
 }

package/CHANGELOG.md

@@ -1,47 +0,0 @@
-# @tinacms/schema-tools
-
-## 0.0.4
-
-### Patch Changes
-
-- 6e2ed31a2: Added `isTitle` property to the schema that allows the title to be displayed in the CMS
-
-## 0.0.3
-
-### Patch Changes
-
-- 921709a7e: Adds validation to the schema instead of only using typescript types
-
-## 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.