@tinacms/datalayer 0.0.0

package/dist/database/bridge/filesystem.d.ts

@@ -0,0 +1,27 @@
+/**
+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 type { Bridge } from './index';
+/**
+ * This is the bridge from whatever datasource we need for I/O.
+ * The basic example here is for the filesystem, one is needed
+ * for Github has well.
+ */
+export declare class FilesystemBridge implements Bridge {
+    rootPath: string;
+    constructor(rootPath: string);
+    glob(pattern: string): Promise<string[]>;
+    supportsBuilding(): boolean;
+    get(filepath: string): Promise<string>;
+    putConfig(filepath: string, data: string): Promise<void>;
+    put(filepath: string, data: string): Promise<void>;
+}

package/dist/database/bridge/github.d.ts

@@ -0,0 +1,33 @@
+/**
+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 { Octokit } from '@octokit/rest';
+import { Bridge } from '.';
+export declare type GithubManagerInit = {
+    rootPath: string;
+    accessToken: string;
+    owner: string;
+    repo: string;
+    ref: string;
+};
+export declare class GithubBridge implements Bridge {
+    rootPath: string;
+    repoConfig: Pick<GithubManagerInit, 'owner' | 'ref' | 'repo'>;
+    appOctoKit: Octokit;
+    constructor({ rootPath, accessToken, owner, repo, ref }: GithubManagerInit);
+    private readDir;
+    supportsBuilding(): boolean;
+    glob(pattern: string): Promise<string[]>;
+    get(filepath: string): Promise<string>;
+    putConfig(filepath: string, data: string): Promise<void>;
+    put(filepath: string, data: string): Promise<void>;
+}

package/dist/database/bridge/index.d.ts

@@ -0,0 +1,23 @@
+/**
+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.
+*/
+export interface Bridge {
+    rootPath: string;
+    glob(pattern: string): Promise<string[]>;
+    get(filepath: string): Promise<string>;
+    put(filepath: string, data: string): Promise<void>;
+    /**
+     * Whether this bridge supports the ability to build the schema.
+     */
+    supportsBuilding(): boolean;
+    putConfig(filepath: string, data: string): Promise<void>;
+}

package/dist/database/store/filesystem.d.ts

@@ -0,0 +1,28 @@
+/**
+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 { Store } from '.';
+export declare class FilesystemStore implements Store {
+    rootPath: string;
+    clear(): Promise<void>;
+    print(): Promise<void>;
+    constructor({ rootPath }: {
+        rootPath?: string;
+    });
+    query(queryStrings: string[]): Promise<object[]>;
+    seed(): Promise<void>;
+    get<T extends object>(filepath: string): Promise<T>;
+    supportsSeeding(): boolean;
+    supportsIndexing(): boolean;
+    glob(pattern: string, callback: any): Promise<any[]>;
+    put(filepath: string, data: object): Promise<void>;
+}

package/dist/database/store/github.d.ts

@@ -0,0 +1,37 @@
+/**
+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 { Octokit } from '@octokit/rest';
+import { Store } from '.';
+export declare type GithubManagerInit = {
+    rootPath: string;
+    accessToken: string;
+    owner: string;
+    repo: string;
+    ref: string;
+};
+export declare class GithubStore implements Store {
+    rootPath: string;
+    repoConfig: Pick<GithubManagerInit, 'owner' | 'ref' | 'repo'>;
+    appOctoKit: Octokit;
+    clear(): Promise<void>;
+    print(): Promise<void>;
+    constructor({ rootPath, accessToken, owner, repo, ref }: GithubManagerInit);
+    query(queryStrings: string[]): Promise<object[]>;
+    supportsSeeding(): boolean;
+    seed(): Promise<void>;
+    private readDir;
+    glob(pattern: string, callback: any): Promise<any[]>;
+    get(filepath: string): Promise<never>;
+    supportsIndexing(): boolean;
+    put(filepath: string, data: object): Promise<void>;
+}

package/dist/database/store/index.d.ts

@@ -0,0 +1,74 @@
+/**
+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.
+*/
+export interface Store {
+    glob(pattern: string, hydrator?: (fullPath: string) => Promise<object>): Promise<string[]>;
+    get<T extends object>(filepath: string): Promise<T>;
+    clear(): void;
+    /**
+     *
+     * @param queryStrings
+     * Queries are currently structured as prefixed keys where that last portion
+     * of the key is the value provided by the query
+     * ```graphql
+     * {
+     *   getPostsList(filter: {
+     *     title: {
+     *       eq: "Hello, World"
+     *     }
+     *   }) {
+     *      ...
+     *   }
+     * }
+     * ```
+     * Would equate to a query string of:
+     * ```
+     * __attribute__#posts#posts#title#Hello, World
+     * ```
+     * This can be used by a data store as a secondary index of sorts
+     *
+     * It's important to note that for now each query string acts as an "AND" clause,
+     * meaning the resulting records need to be present in _each_ query string.
+     *
+     * @param hydrator
+     * hydrator is an optional callback, which may be useful depending on the storage mechanism.
+     * For example, the in-memory storage only stores the path to its records as its value,
+     * but in something like DynamoDB the query strings may be used to look up the full record,
+     * meaning there's no need to "hydrate" the return value
+     */
+    query(queryStrings: string[], hydrator?: (fullPath: string) => Promise<object>): Promise<object[]>;
+    /**
+     * In this context, seeding is the act of putting records and indexing data into an ephemeral
+     * storage layer for use during the GraphQL runtime. What might seem suprising is that some stores
+     * don't support seeding, this is because they're behaving more like a "bridge" (GithubStore and FilesystemStore).
+     * Currently they're acting as a way to swap out true data-layer behavior with a backwards-compatible
+     * "store". In the future, all stores should be able to query and seed data.
+     *
+     * At this time it seems that it would never make sense to be able to "query" without "seed"-ing, and
+     * there'd be no value in "seeding" without "query"-ing.
+     */
+    seed(filepath: string, data: object, options?: {
+        includeTemplate?: boolean;
+    }): Promise<void>;
+    supportsSeeding(): boolean;
+    /**
+     * Whether this store supports the ability to index data.
+     * Indexing data requires writing arbitrary keys/values to
+     * the external service, so is not advisable to use for
+     * something like Github, which would write commits to the
+     * user's repo.
+     */
+    supportsIndexing(): boolean;
+    put(filepath: string, data: object, options?: {
+        includeTemplate?: boolean;
+    }): Promise<void>;
+}

package/dist/database/store/level.d.ts

@@ -0,0 +1,29 @@
+/**
+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 type { Store } from './index';
+import { LevelDB } from 'level';
+export declare class LevelStore implements Store {
+    rootPath: any;
+    db: LevelDB;
+    constructor(rootPath: string, useMemory?: boolean);
+    query(queryStrings: string[], hydrator: any): Promise<any[]>;
+    seed(filepath: string, data: object): Promise<void>;
+    supportsSeeding(): boolean;
+    supportsIndexing(): boolean;
+    print(): Promise<void>;
+    open(): Promise<void>;
+    clear(): Promise<void>;
+    glob(pattern: string, callback: any): Promise<any[]>;
+    get(filepath: string): Promise<any>;
+    put(filepath: string, data: object): Promise<void>;
+}

package/dist/database/store/memory.d.ts

@@ -0,0 +1,33 @@
+/**
+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 type { Store } from './index';
+/**
+ * This is the bridge from whatever datasource we need for I/O.
+ * The basic example here is for the filesystem, one is needed
+ * for Github has well.
+ */
+export declare class MemoryStore implements Store {
+    rootPath: any;
+    db: any;
+    private map;
+    constructor(rootPath: string, object?: object);
+    query(queryStrings: string[], hydrator: any): Promise<any[]>;
+    seed(filepath: string, data: object): Promise<void>;
+    supportsSeeding(): boolean;
+    supportsIndexing(): boolean;
+    print(): Promise<void>;
+    clear(): Promise<void>;
+    glob(pattern: string, callback: any): Promise<any[]>;
+    get(filepath: string): Promise<any>;
+    put(filepath: string, data: object): Promise<void>;
+}

package/dist/database/util.d.ts

@@ -0,0 +1,16 @@
+/**
+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 yup from 'yup';
+export declare const stringifyFile: (content: object, format: FormatType | string, keepTemplateKey: boolean) => string;
+export declare const parseFile: <T extends object>(content: string, format: FormatType | string, yupSchema: (args: typeof yup) => yup.ObjectSchema<any>) => T;
+export declare type FormatType = 'json' | 'md' | 'mdx' | 'markdown';

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+/**
+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.
+*/
+export { GithubBridge } from './database/bridge/github';
+export { GithubStore } from './database/store/github';
+export { FilesystemBridge } from './database/bridge/filesystem';
+export { FilesystemStore } from './database/store/filesystem';
+export { MemoryStore } from './database/store/memory';
+export { LevelStore } from './database/store/level';
+export type { GithubManagerInit } from './database/bridge/github';