@tinacms/graphql 0.56.1 → 0.58.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/CHANGELOG.md +35 -0
  2. package/dist/{primitives/ast-builder → ast-builder}/index.d.ts +40 -1
  3. package/dist/build.d.ts +18 -0
  4. package/dist/{primitives/builder → builder}/index.d.ts +23 -2
  5. package/dist/{primitives/builder → builder}/static-definitions.d.ts +0 -0
  6. package/dist/{primitives/database/bridge.d.ts → database/bridge/filesystem.d.ts} +3 -5
  7. package/dist/{primitives/database → database/bridge}/github.d.ts +4 -23
  8. package/dist/database/bridge/index.d.ts +23 -0
  9. package/dist/{primitives/database → database}/index.d.ts +26 -16
  10. package/dist/{cache/lru.d.ts → database/store/filesystem.d.ts} +16 -14
  11. package/dist/database/store/github.d.ts +37 -0
  12. package/dist/database/store/index.d.ts +74 -0
  13. package/dist/database/store/level.d.ts +29 -0
  14. package/dist/database/store/memory.d.ts +33 -0
  15. package/dist/database/util.d.ts +16 -0
  16. package/dist/index.d.ts +13 -7
  17. package/dist/index.js +2055 -852
  18. package/dist/{primitives/mdx → mdx}/index.d.ts +0 -0
  19. package/dist/{primitives/mdx → mdx}/parse.d.ts +0 -0
  20. package/dist/{primitives/mdx → mdx}/stringify.d.ts +0 -0
  21. package/dist/{primitives/resolve.d.ts → resolve.d.ts} +0 -0
  22. package/dist/{primitives/resolver → resolver}/error.d.ts +12 -0
  23. package/dist/{primitives/resolver → resolver}/index.d.ts +3 -34
  24. package/dist/{primitives/schema → schema}/index.d.ts +1 -0
  25. package/dist/schema/validate.d.ts +14 -0
  26. package/dist/{primitives/build.d.ts → sdkBuilder/index.d.ts} +2 -4
  27. package/dist/{primitives/spec → spec}/setup.d.ts +24 -30
  28. package/dist/{primitives/types.d.ts → types.d.ts} +2 -1
  29. package/dist/{primitives/util.d.ts → util.d.ts} +0 -0
  30. package/package.json +14 -18
  31. package/dist/cache/s3.d.ts +0 -31
  32. package/dist/primitives/index.d.ts +0 -42
package/CHANGELOG.md CHANGED
@@ -1,5 +1,40 @@
1
1
  # tina-graphql
2
2
 
3
+ ## 0.58.0
4
+
5
+ ### Minor Changes
6
+
7
+ - fa7a0419f: Adds experimental support for a data layer between file-based content and the GraphQL API. This allows documents to be indexed so the CMS can behave more like a traditional CMS, with the ability enforce foreign reference constraints and filtering/pagination capabilities.
8
+
9
+ ### Patch Changes
10
+
11
+ - eb5fbfac7: Ensure GraphQL resolve doesn't access "bridge" documents
12
+ - 47d126029: Fix support of objects in a list for MDX templates
13
+
14
+ ## 0.57.2
15
+
16
+ ### Patch Changes
17
+
18
+ - edb2f4011: Trim path property on collections during compilation
19
+
20
+ ## 0.57.1
21
+
22
+ ### Patch Changes
23
+
24
+ - 60729f60c: Adds a `reference` field
25
+
26
+ ## 0.57.0
27
+
28
+ ### Minor Changes
29
+
30
+ - ed277e3bd: Remove aws dependency and cache logic from GithubBridge
31
+ - d1ed404ba: Add support for auto-generated SDK for type-safe data fetching
32
+
33
+ ### Patch Changes
34
+
35
+ - 138ceb8c4: Clean up dependencies
36
+ - 577d6a5ad: Adds collection arg back for generic queries as optional
37
+
3
38
  ## 0.56.1
4
39
 
5
40
  ### Patch Changes
@@ -10,7 +10,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10
10
  See the License for the specific language governing permissions and
11
11
  limitations under the License.
12
12
  */
13
- import { FieldDefinitionNode, ScalarTypeDefinitionNode, InputValueDefinitionNode, ObjectTypeDefinitionNode, InterfaceTypeDefinitionNode, NamedTypeNode, UnionTypeDefinitionNode, TypeDefinitionNode, DirectiveNode, EnumTypeDefinitionNode, InputObjectTypeDefinitionNode, DocumentNode } from 'graphql';
13
+ import { FieldDefinitionNode, ScalarTypeDefinitionNode, InputValueDefinitionNode, ObjectTypeDefinitionNode, InterfaceTypeDefinitionNode, NamedTypeNode, UnionTypeDefinitionNode, TypeDefinitionNode, DirectiveNode, EnumTypeDefinitionNode, InputObjectTypeDefinitionNode, DocumentNode, FragmentDefinitionNode, SelectionNode, FieldNode, InlineFragmentNode, OperationDefinitionNode } from 'graphql';
14
14
  /**
15
15
  * the `gql` module provides functions and types which can be
16
16
  * used to build up the GraphQL AST. The primary reason for us using
@@ -45,6 +45,13 @@ export declare const astBuilder: {
45
45
  required?: boolean;
46
46
  values: string[];
47
47
  }) => EnumTypeDefinitionNode;
48
+ FieldNodeDefinition: ({ name, type, args, list, required, }: {
49
+ name: string;
50
+ type: string | TypeDefinitionNode;
51
+ required?: boolean;
52
+ list?: boolean;
53
+ args?: InputValueDefinitionNode[];
54
+ }) => FieldNode;
48
55
  FieldDefinition: ({ name, type, args, list, required, }: {
49
56
  name: string;
50
57
  type: string | TypeDefinitionNode;
@@ -75,6 +82,29 @@ export declare const astBuilder: {
75
82
  directives?: DirectiveNode[];
76
83
  args?: NamedTypeNode[];
77
84
  }) => ObjectTypeDefinitionNode;
85
+ FieldWithSelectionSetDefinition: ({ name, selections, }: {
86
+ name: string;
87
+ selections: SelectionNode[];
88
+ }) => {
89
+ name: {
90
+ kind: "Name";
91
+ value: string;
92
+ };
93
+ kind: "Field";
94
+ selectionSet: {
95
+ kind: "SelectionSet";
96
+ selections: SelectionNode[];
97
+ };
98
+ };
99
+ InlineFragmentDefinition: ({ name, selections, }: {
100
+ name: string;
101
+ selections: SelectionNode[];
102
+ }) => InlineFragmentNode;
103
+ FragmentDefinition: ({ name, fragmentName, selections, }: {
104
+ name: string;
105
+ fragmentName: string;
106
+ selections: SelectionNode[];
107
+ }) => FragmentDefinitionNode;
78
108
  TYPES: {
79
109
  Scalar: (type: scalarNames) => string;
80
110
  MultiCollectionDocument: string;
@@ -92,6 +122,14 @@ export declare const astBuilder: {
92
122
  Number: string;
93
123
  Document: string;
94
124
  };
125
+ QueryOperationDefinition: ({ queryName, fragName, }: {
126
+ queryName: string;
127
+ fragName: string;
128
+ }) => OperationDefinitionNode;
129
+ ListQueryOperationDefinition: ({ queryName, fragName, }: {
130
+ queryName: string;
131
+ fragName: string;
132
+ }) => OperationDefinitionNode;
95
133
  toGraphQLAst: (ast: {
96
134
  globalTemplates: TypeDefinitionNode[];
97
135
  query: TypeDefinitionNode;
@@ -111,6 +149,7 @@ export declare const NAMER: {
111
149
  createName: (namespace: string[]) => string;
112
150
  queryName: (namespace: string[]) => string;
113
151
  generateQueryListName: (namespace: string[]) => string;
152
+ fragmentName: (namespace: string[]) => string;
114
153
  collectionTypeName: (namespace: string[]) => string;
115
154
  documentTypeName: (namespace: string[]) => string;
116
155
  dataTypeName: (namespace: string[]) => string;
@@ -0,0 +1,18 @@
1
+ /**
2
+ Copyright 2021 Forestry.io Holdings, Inc.
3
+ Licensed under the Apache License, Version 2.0 (the "License");
4
+ you may not use this file except in compliance with the License.
5
+ You may obtain a copy of the License at
6
+ http://www.apache.org/licenses/LICENSE-2.0
7
+ Unless required by applicable law or agreed to in writing, software
8
+ distributed under the License is distributed on an "AS IS" BASIS,
9
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10
+ See the License for the specific language governing permissions and
11
+ limitations under the License.
12
+ */
13
+ import type { TinaSchema } from './schema';
14
+ import { Database } from './database';
15
+ export declare const indexDB: ({ database, config, }: {
16
+ database: Database;
17
+ config: TinaSchema['config'];
18
+ }) => Promise<void>;
@@ -11,8 +11,8 @@ See the License for the specific language governing permissions and
11
11
  limitations under the License.
12
12
  */
13
13
  import { Database } from '../database';
14
- import type { ObjectTypeDefinitionNode } from 'graphql';
15
- import type { TinaCloudCollectionEnriched } from '../types';
14
+ import type { ObjectTypeDefinitionNode, InlineFragmentNode } from 'graphql';
15
+ import type { TinaCloudCollectionEnriched, Template } from '../types';
16
16
  import { TinaSchema } from '../schema';
17
17
  export declare const createBuilder: ({ database, tinaSchema, }: {
18
18
  database: Database;
@@ -169,6 +169,23 @@ export declare class Builder {
169
169
  * @param collection
170
170
  */
171
171
  collectionDocument: (collection: TinaCloudCollectionEnriched) => Promise<import("graphql").FieldDefinitionNode>;
172
+ /**
173
+ * Turns a collection into a fragment that gets updated on build. This fragment does not resolve references
174
+ * ```graphql
175
+ * # ex.
176
+ * fragment AuthorsParts on Authors {
177
+ * name
178
+ * avatar
179
+ * ...
180
+ * }
181
+ * ```
182
+ *
183
+ * @public
184
+ * @param collection a Tina Cloud collection
185
+ */
186
+ collectionFragment: (collection: TinaCloudCollectionEnriched) => Promise<import("graphql").FragmentDefinitionNode>;
187
+ private _buildFieldNodeForFragments;
188
+ buildTemplateFragments(template: Template<true>): Promise<InlineFragmentNode>;
172
189
  /**
173
190
  * ```graphql
174
191
  * # ex.
@@ -220,13 +237,17 @@ export declare class Builder {
220
237
  */
221
238
  buildStaticDefinitions: () => (import("graphql").ScalarTypeDefinitionNode | ObjectTypeDefinitionNode | import("graphql").InterfaceTypeDefinitionNode[])[];
222
239
  private _buildCollectionDocumentType;
240
+ private _filterCollectionDocumentType;
241
+ private _buildTemplateFilter;
223
242
  private _updateCollectionDocumentMutationType;
224
243
  private _buildTemplateMutation;
225
244
  private _buildMultiCollectionDocumentDefinition;
226
245
  private _buildMultiCollectionDocumentListDefinition;
246
+ private _buildFieldFilter;
227
247
  private _buildFieldMutation;
228
248
  private _buildReferenceMutation;
229
249
  private _buildObjectOrUnionData;
250
+ private _connectionFilterBuilder;
230
251
  private _connectionFieldBuilder;
231
252
  private _buildDataField;
232
253
  private _buildTemplateData;
@@ -10,6 +10,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10
10
  See the License for the specific language governing permissions and
11
11
  limitations under the License.
12
12
  */
13
+ import type { Bridge } from './index';
13
14
  /**
14
15
  * This is the bridge from whatever datasource we need for I/O.
15
16
  * The basic example here is for the filesystem, one is needed
@@ -19,11 +20,8 @@ export declare class FilesystemBridge implements Bridge {
19
20
  rootPath: string;
20
21
  constructor(rootPath: string);
21
22
  glob(pattern: string): Promise<string[]>;
23
+ supportsBuilding(): boolean;
22
24
  get(filepath: string): Promise<string>;
23
- put(filepath: string, data: string): Promise<void>;
24
- }
25
- export interface Bridge {
26
- glob(pattern: string): Promise<string[]>;
27
- get(filepath: string): Promise<string>;
25
+ putConfig(filepath: string, data: string): Promise<void>;
28
26
  put(filepath: string, data: string): Promise<void>;
29
27
  }
@@ -11,42 +11,23 @@ See the License for the specific language governing permissions and
11
11
  limitations under the License.
12
12
  */
13
13
  import { Octokit } from '@octokit/rest';
14
- import { Bridge } from './bridge';
14
+ import { Bridge } from '.';
15
15
  export declare type GithubManagerInit = {
16
16
  rootPath: string;
17
17
  accessToken: string;
18
18
  owner: string;
19
19
  repo: string;
20
20
  ref: string;
21
- cache?: typeof dummyCache;
22
- };
23
- declare const dummyCache: {
24
- get: <T extends string | string[]>(key: string, setter: () => Promise<T>) => Promise<T>;
25
21
  };
26
22
  export declare class GithubBridge implements Bridge {
27
23
  rootPath: string;
28
24
  repoConfig: Pick<GithubManagerInit, 'owner' | 'ref' | 'repo'>;
29
25
  appOctoKit: Octokit;
30
- cache: typeof dummyCache;
31
- constructor({ rootPath, accessToken, owner, repo, ref, cache, }: GithubManagerInit);
32
- private generateKey;
26
+ constructor({ rootPath, accessToken, owner, repo, ref }: GithubManagerInit);
33
27
  private readDir;
28
+ supportsBuilding(): boolean;
34
29
  glob(pattern: string): Promise<string[]>;
35
30
  get(filepath: string): Promise<string>;
31
+ putConfig(filepath: string, data: string): Promise<void>;
36
32
  put(filepath: string, data: string): Promise<void>;
37
33
  }
38
- export declare const clearCache: ({ owner, repo, ref, path, }: {
39
- owner: string;
40
- repo: string;
41
- ref: string;
42
- path?: string;
43
- }) => void;
44
- /**
45
- * This is just an example of what you can provide for caching
46
- * it should be replaced with a scalable solution which shares a cache
47
- * across lambda instances (like redis)
48
- */
49
- export declare const simpleCache: {
50
- get: (keyName: string, setter: () => Promise<any>) => Promise<any>;
51
- };
52
- export {};
@@ -0,0 +1,23 @@
1
+ /**
2
+ Copyright 2021 Forestry.io Holdings, Inc.
3
+ Licensed under the Apache License, Version 2.0 (the "License");
4
+ you may not use this file except in compliance with the License.
5
+ You may obtain a copy of the License at
6
+ http://www.apache.org/licenses/LICENSE-2.0
7
+ Unless required by applicable law or agreed to in writing, software
8
+ distributed under the License is distributed on an "AS IS" BASIS,
9
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10
+ See the License for the specific language governing permissions and
11
+ limitations under the License.
12
+ */
13
+ export interface Bridge {
14
+ rootPath: string;
15
+ glob(pattern: string): Promise<string[]>;
16
+ get(filepath: string): Promise<string>;
17
+ put(filepath: string, data: string): Promise<void>;
18
+ /**
19
+ * Whether this bridge supports the ability to build the schema.
20
+ */
21
+ supportsBuilding(): boolean;
22
+ putConfig(filepath: string, data: string): Promise<void>;
23
+ }
@@ -10,43 +10,53 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10
10
  See the License for the specific language governing permissions and
11
11
  limitations under the License.
12
12
  */
13
- import { Bridge } from './bridge';
13
+ import type { DocumentNode } from 'graphql';
14
+ import type { TinaSchema } from '../schema';
14
15
  import type { TinaCloudSchemaBase } from '../types';
15
- import { DocumentNode } from 'graphql';
16
+ import type { Store } from './store';
17
+ import type { Bridge } from './bridge';
16
18
  declare type CreateDatabase = {
17
- rootPath?: string;
18
- bridge?: Bridge;
19
+ bridge: Bridge;
20
+ store: Store;
19
21
  };
20
22
  export declare const createDatabase: (config: CreateDatabase) => Promise<Database>;
21
23
  export declare class Database {
22
24
  config: CreateDatabase;
23
25
  bridge: Bridge;
26
+ store: Store;
24
27
  private tinaSchema;
25
28
  private _lookup;
26
29
  private _graphql;
27
30
  private _tinaSchema;
28
31
  constructor(config: CreateDatabase);
29
32
  get: <T extends object>(filepath: string) => Promise<T>;
33
+ addPendingDocument: (filepath: string, data: {
34
+ [key: string]: unknown;
35
+ }) => Promise<void>;
30
36
  put: (filepath: string, data: {
31
37
  [key: string]: unknown;
32
38
  }) => Promise<boolean>;
39
+ stringifyFile: (filepath: string, data: {
40
+ [key: string]: unknown;
41
+ }) => Promise<{
42
+ stringifiedFile: string;
43
+ payload: {
44
+ [key: string]: unknown;
45
+ };
46
+ }>;
47
+ flush: (filepath: string) => Promise<string>;
33
48
  getLookup: (returnType: string) => Promise<LookupMapType>;
34
49
  getGraphQLSchema: () => Promise<DocumentNode>;
50
+ getGraphQLSchemaFromBridge: () => Promise<DocumentNode>;
35
51
  getTinaSchema: () => Promise<TinaCloudSchemaBase>;
36
- private getSchema;
37
- getDocument: (fullPath: unknown) => Promise<{
38
- __typename: string;
39
- id: string;
40
- data: {
41
- _collection: string;
42
- _template: string;
43
- };
44
- }>;
52
+ getSchema: () => Promise<TinaSchema>;
45
53
  documentExists: (fullpath: unknown) => Promise<boolean>;
46
- getDocumentsForCollection: (collectionName: string) => Promise<string[]>;
54
+ query: (queryStrings: string[], hydrator: any) => Promise<object[]>;
55
+ indexData: ({ graphQLSchema, tinaSchema, }: {
56
+ graphQLSchema: DocumentNode;
57
+ tinaSchema: TinaSchema;
58
+ }) => Promise<void>;
47
59
  addToLookupMap: (lookup: LookupMapType) => Promise<void>;
48
- private stringifyFile;
49
- private parseFile;
50
60
  }
51
61
  export declare type LookupMapType = GlobalDocumentLookup | CollectionDocumentLookup | MultiCollectionDocumentLookup | MultiCollectionDocumentListLookup | CollectionDocumentListLookup | UnionDataLookup | NodeDocument;
52
62
  declare type NodeDocument = {
@@ -10,17 +10,19 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10
10
  See the License for the specific language governing permissions and
11
11
  limitations under the License.
12
12
  */
13
- export declare const clearCache: ({ owner, repo, ref, path, }: {
14
- owner: string;
15
- repo: string;
16
- ref: string;
17
- path?: string;
18
- }) => void;
19
- /**
20
- * This is just an example of what you can provide for caching
21
- * it should be replaced with a scalable solution which shares a cache
22
- * across lambda instances (like redis)
23
- */
24
- export declare const simpleCache: {
25
- get: (keyName: string, setter: () => Promise<any>) => Promise<any>;
26
- };
13
+ import { Store } from '.';
14
+ export declare class FilesystemStore implements Store {
15
+ rootPath: string;
16
+ clear(): Promise<void>;
17
+ print(): Promise<void>;
18
+ constructor({ rootPath }: {
19
+ rootPath?: string;
20
+ });
21
+ query(queryStrings: string[]): Promise<object[]>;
22
+ seed(): Promise<void>;
23
+ get<T extends object>(filepath: string): Promise<T>;
24
+ supportsSeeding(): boolean;
25
+ supportsIndexing(): boolean;
26
+ glob(pattern: string, callback: any): Promise<any[]>;
27
+ put(filepath: string, data: object): Promise<void>;
28
+ }
@@ -0,0 +1,37 @@
1
+ /**
2
+ Copyright 2021 Forestry.io Holdings, Inc.
3
+ Licensed under the Apache License, Version 2.0 (the "License");
4
+ you may not use this file except in compliance with the License.
5
+ You may obtain a copy of the License at
6
+ http://www.apache.org/licenses/LICENSE-2.0
7
+ Unless required by applicable law or agreed to in writing, software
8
+ distributed under the License is distributed on an "AS IS" BASIS,
9
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10
+ See the License for the specific language governing permissions and
11
+ limitations under the License.
12
+ */
13
+ import { Octokit } from '@octokit/rest';
14
+ import { Store } from '.';
15
+ export declare type GithubManagerInit = {
16
+ rootPath: string;
17
+ accessToken: string;
18
+ owner: string;
19
+ repo: string;
20
+ ref: string;
21
+ };
22
+ export declare class GithubStore implements Store {
23
+ rootPath: string;
24
+ repoConfig: Pick<GithubManagerInit, 'owner' | 'ref' | 'repo'>;
25
+ appOctoKit: Octokit;
26
+ clear(): Promise<void>;
27
+ print(): Promise<void>;
28
+ constructor({ rootPath, accessToken, owner, repo, ref }: GithubManagerInit);
29
+ query(queryStrings: string[]): Promise<object[]>;
30
+ supportsSeeding(): boolean;
31
+ seed(): Promise<void>;
32
+ private readDir;
33
+ glob(pattern: string, callback: any): Promise<any[]>;
34
+ get(filepath: string): Promise<never>;
35
+ supportsIndexing(): boolean;
36
+ put(filepath: string, data: object): Promise<void>;
37
+ }
@@ -0,0 +1,74 @@
1
+ /**
2
+ Copyright 2021 Forestry.io Holdings, Inc.
3
+ Licensed under the Apache License, Version 2.0 (the "License");
4
+ you may not use this file except in compliance with the License.
5
+ You may obtain a copy of the License at
6
+ http://www.apache.org/licenses/LICENSE-2.0
7
+ Unless required by applicable law or agreed to in writing, software
8
+ distributed under the License is distributed on an "AS IS" BASIS,
9
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10
+ See the License for the specific language governing permissions and
11
+ limitations under the License.
12
+ */
13
+ export interface Store {
14
+ glob(pattern: string, hydrator?: (fullPath: string) => Promise<object>): Promise<string[]>;
15
+ get<T extends object>(filepath: string): Promise<T>;
16
+ clear(): void;
17
+ /**
18
+ *
19
+ * @param queryStrings
20
+ * Queries are currently structured as prefixed keys where that last portion
21
+ * of the key is the value provided by the query
22
+ * ```graphql
23
+ * {
24
+ * getPostsList(filter: {
25
+ * title: {
26
+ * eq: "Hello, World"
27
+ * }
28
+ * }) {
29
+ * ...
30
+ * }
31
+ * }
32
+ * ```
33
+ * Would equate to a query string of:
34
+ * ```
35
+ * __attribute__#posts#posts#title#Hello, World
36
+ * ```
37
+ * This can be used by a data store as a secondary index of sorts
38
+ *
39
+ * It's important to note that for now each query string acts as an "AND" clause,
40
+ * meaning the resulting records need to be present in _each_ query string.
41
+ *
42
+ * @param hydrator
43
+ * hydrator is an optional callback, which may be useful depending on the storage mechanism.
44
+ * For example, the in-memory storage only stores the path to its records as its value,
45
+ * but in something like DynamoDB the query strings may be used to look up the full record,
46
+ * meaning there's no need to "hydrate" the return value
47
+ */
48
+ query(queryStrings: string[], hydrator?: (fullPath: string) => Promise<object>): Promise<object[]>;
49
+ /**
50
+ * In this context, seeding is the act of putting records and indexing data into an ephemeral
51
+ * storage layer for use during the GraphQL runtime. What might seem suprising is that some stores
52
+ * don't support seeding, this is because they're behaving more like a "bridge" (GithubStore and FilesystemStore).
53
+ * Currently they're acting as a way to swap out true data-layer behavior with a backwards-compatible
54
+ * "store". In the future, all stores should be able to query and seed data.
55
+ *
56
+ * At this time it seems that it would never make sense to be able to "query" without "seed"-ing, and
57
+ * there'd be no value in "seeding" without "query"-ing.
58
+ */
59
+ seed(filepath: string, data: object, options?: {
60
+ includeTemplate?: boolean;
61
+ }): Promise<void>;
62
+ supportsSeeding(): boolean;
63
+ /**
64
+ * Whether this store supports the ability to index data.
65
+ * Indexing data requires writing arbitrary keys/values to
66
+ * the external service, so is not advisable to use for
67
+ * something like Github, which would write commits to the
68
+ * user's repo.
69
+ */
70
+ supportsIndexing(): boolean;
71
+ put(filepath: string, data: object, options?: {
72
+ includeTemplate?: boolean;
73
+ }): Promise<void>;
74
+ }
@@ -0,0 +1,29 @@
1
+ /**
2
+ Copyright 2021 Forestry.io Holdings, Inc.
3
+ Licensed under the Apache License, Version 2.0 (the "License");
4
+ you may not use this file except in compliance with the License.
5
+ You may obtain a copy of the License at
6
+ http://www.apache.org/licenses/LICENSE-2.0
7
+ Unless required by applicable law or agreed to in writing, software
8
+ distributed under the License is distributed on an "AS IS" BASIS,
9
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10
+ See the License for the specific language governing permissions and
11
+ limitations under the License.
12
+ */
13
+ import type { Store } from './index';
14
+ import { LevelDB } from 'level';
15
+ export declare class LevelStore implements Store {
16
+ rootPath: any;
17
+ db: LevelDB;
18
+ constructor(rootPath: string, useMemory?: boolean);
19
+ query(queryStrings: string[], hydrator: any): Promise<any[]>;
20
+ seed(filepath: string, data: object): Promise<void>;
21
+ supportsSeeding(): boolean;
22
+ supportsIndexing(): boolean;
23
+ print(): Promise<void>;
24
+ open(): Promise<void>;
25
+ clear(): Promise<void>;
26
+ glob(pattern: string, callback: any): Promise<any[]>;
27
+ get(filepath: string): Promise<any>;
28
+ put(filepath: string, data: object): Promise<void>;
29
+ }
@@ -0,0 +1,33 @@
1
+ /**
2
+ Copyright 2021 Forestry.io Holdings, Inc.
3
+ Licensed under the Apache License, Version 2.0 (the "License");
4
+ you may not use this file except in compliance with the License.
5
+ You may obtain a copy of the License at
6
+ http://www.apache.org/licenses/LICENSE-2.0
7
+ Unless required by applicable law or agreed to in writing, software
8
+ distributed under the License is distributed on an "AS IS" BASIS,
9
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10
+ See the License for the specific language governing permissions and
11
+ limitations under the License.
12
+ */
13
+ import type { Store } from './index';
14
+ /**
15
+ * This is the bridge from whatever datasource we need for I/O.
16
+ * The basic example here is for the filesystem, one is needed
17
+ * for Github has well.
18
+ */
19
+ export declare class MemoryStore implements Store {
20
+ rootPath: any;
21
+ db: any;
22
+ private map;
23
+ constructor(rootPath: string, object?: object);
24
+ query(queryStrings: string[], hydrator: any): Promise<any[]>;
25
+ seed(filepath: string, data: object): Promise<void>;
26
+ supportsSeeding(): boolean;
27
+ supportsIndexing(): boolean;
28
+ print(): Promise<void>;
29
+ clear(): Promise<void>;
30
+ glob(pattern: string, callback: any): Promise<any[]>;
31
+ get(filepath: string): Promise<any>;
32
+ put(filepath: string, data: object): Promise<void>;
33
+ }
@@ -0,0 +1,16 @@
1
+ /**
2
+ Copyright 2021 Forestry.io Holdings, Inc.
3
+ Licensed under the Apache License, Version 2.0 (the "License");
4
+ you may not use this file except in compliance with the License.
5
+ You may obtain a copy of the License at
6
+ http://www.apache.org/licenses/LICENSE-2.0
7
+ Unless required by applicable law or agreed to in writing, software
8
+ distributed under the License is distributed on an "AS IS" BASIS,
9
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10
+ See the License for the specific language governing permissions and
11
+ limitations under the License.
12
+ */
13
+ import * as yup from 'yup';
14
+ export declare const stringifyFile: (content: object, format: FormatType | string, keepTemplateKey: boolean) => string;
15
+ export declare const parseFile: <T extends object>(content: string, format: FormatType | string, yupSchema: (args: typeof yup) => yup.ObjectSchema<any>) => T;
16
+ export declare type FormatType = 'json' | 'md' | 'mdx' | 'markdown';
package/dist/index.d.ts CHANGED
@@ -10,13 +10,19 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10
10
  See the License for the specific language governing permissions and
11
11
  limitations under the License.
12
12
  */
13
- export { GithubBridge } from './primitives/database/github';
14
- export type { GithubManagerInit } from './primitives/database/github';
15
- export { gql, resolve, buildSchema, indexDB, createDatabase, githubRoute, } from './primitives';
16
- import { clearCache as s3ClearCache, s3Cache } from './cache/s3';
17
- import { clearCache as lruClearCache, simpleCache } from './cache/lru';
18
- export { lruClearCache, lruClearCache as clearCache, s3ClearCache, s3Cache, simpleCache, };
19
- import type { TinaCloudSchema as TinaCloudSchemaBase, TinaCloudCollection as TinaCloudCollectionBase, TinaCloudTemplateBase as TinaTemplate, TinaFieldBase } from './primitives/types';
13
+ export { indexDB } from './build';
14
+ export { resolve } from './resolve';
15
+ export { createDatabase } from './database';
16
+ export { GithubBridge } from './database/bridge/github';
17
+ export { GithubStore } from './database/store/github';
18
+ export { FilesystemBridge } from './database/bridge/filesystem';
19
+ export { FilesystemStore } from './database/store/filesystem';
20
+ export { MemoryStore } from './database/store/memory';
21
+ export { LevelStore } from './database/store/level';
22
+ export type { GithubManagerInit } from './database/bridge/github';
23
+ import type { Database } from './database';
24
+ export declare const buildSchema: (rootPath: string, database: Database) => Promise<import("graphql").GraphQLSchema>;
25
+ import type { TinaCloudSchema as TinaCloudSchemaBase, TinaCloudCollection as TinaCloudCollectionBase, TinaCloudTemplateBase as TinaTemplate, TinaFieldBase } from './types';
20
26
  export declare const listBranches: ({ auth, owner, repo }: {
21
27
  auth: any;
22
28
  owner: any;