@tinacms/datalayer 1.0.0 → 1.1.0

package/package.json

@@ -1,13 +1,18 @@
 {
   "name": "@tinacms/datalayer",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "main": "dist/index.js",
+  "module": "dist/index.es.js",
   "typings": "dist/index.d.ts",
   "files": [
     "package.json",
     "dist"
   ],
-  "license": "Apache-2.0",
+  "exports": {
+    "import": "./dist/index.es.js",
+    "require": "./dist/index.js"
+  },
+  "license": "SEE LICENSE IN LICENSE",
   "buildConfig": {
     "entryPoints": [
       {
@@ -18,26 +23,7 @@
     ]
   },
   "dependencies": {
-    "@octokit/auth-app": "^2.6.0",
-    "@octokit/graphql": "^4.5.6",
-    "@octokit/rest": "18.0.6",
-    "encoding-down": "^7.1.0",
-    "fast-glob": "^3.2.5",
-    "fs-extra": "^9.0.1",
-    "glob-parent": "^6.0.2",
-    "graphql": "15.8.0",
-    "gray-matter": "^4.0.2",
-    "isomorphic-git": "^1.10.3",
-    "js-yaml": "^3.14.0",
-    "jsonpath-plus": "^6.0.1",
-    "level": "^7.0.1",
-    "leveldown": "^6.1.0",
-    "levelup": "^5.1.1",
-    "lodash": "^4.17.20",
-    "memdown": "^6.1.1",
-    "normalize-path": "^3.0.0",
-    "prettier": "^2.2.1",
-    "yup": "^0.32.9"
+    "@tinacms/graphql": "1.2.0"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
@@ -47,7 +33,7 @@
     "directory": "packages/@tinacms/datalayer"
   },
   "devDependencies": {
-    "@tinacms/scripts": "1.0.0",
+    "@tinacms/scripts": "1.0.2",
     "@types/fs-extra": "^9.0.2",
     "@types/jest": "^27.4.1",
     "@types/js-yaml": "^3.12.5",

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

@@ -1,34 +0,0 @@
-/**
-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, extension: string): Promise<string[]>;
-    supportsBuilding(): boolean;
-    delete(filepath: string): Promise<void>;
-    get(filepath: string): Promise<string>;
-    putConfig(filepath: string, data: string): Promise<void>;
-    put(filepath: string, data: string): Promise<void>;
-}
-/**
- * Same as the `FileSystemBridge` except it does not save files
- */
-export declare class AuditFileSystemBridge extends FilesystemBridge {
-    put(filepath: string, data: string): Promise<void>;
-}

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

@@ -1,24 +0,0 @@
-/**
-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, extension: string): Promise<string[]>;
-    delete(filepath: string): Promise<void>;
-    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/bridge/isomorphic.d.ts

@@ -1,108 +0,0 @@
-/**
- 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 { CallbackFsClient, PromiseFsClient } from 'isomorphic-git';
-import type { Bridge } from './index';
-export declare type IsomorphicGitBridgeOptions = {
-    gitRoot: string;
-    fsModule?: CallbackFsClient | PromiseFsClient;
-    commitMessage?: string;
-    author: {
-        name: string;
-        email: string;
-    };
-    committer?: {
-        name: string;
-        email: string;
-    };
-    ref?: string;
-    onPut?: (filepath: string, data: string) => Promise<void>;
-    onDelete?: (filepath: string) => Promise<void>;
-};
-/**
- * Bridge backed by isomorphic-git
- */
-export declare class IsomorphicBridge implements Bridge {
-    rootPath: string;
-    relativePath: string;
-    gitRoot: string;
-    fsModule: CallbackFsClient | PromiseFsClient;
-    isomorphicConfig: {
-        fs: CallbackFsClient | PromiseFsClient;
-        dir: string;
-    };
-    commitMessage: string;
-    author: {
-        name: string;
-        email: string;
-    };
-    committer: {
-        name: string;
-        email: string;
-    };
-    ref: string | undefined;
-    private readonly onPut;
-    private readonly onDelete;
-    private cache;
-    constructor(rootPath: string, { gitRoot, author, committer, fsModule, commitMessage, ref, onPut, onDelete, }: IsomorphicGitBridgeOptions);
-    private getAuthor;
-    private getCommitter;
-    /**
-     * Recursively populate paths matching `pattern` for the given `entry`
-     *
-     * @param pattern - pattern to filter paths by
-     * @param entry - TreeEntry to start building list from
-     * @param path - base path
-     * @param results
-     * @private
-     */
-    private listEntries;
-    /**
-     * For the specified path, returns an object with an array containing the parts of the path (pathParts)
-     * and an array containing the WalkerEntry objects for the path parts (pathEntries). Any null elements in the
-     * pathEntries are placeholders for non-existent entries.
-     *
-     * @param path - path being resolved
-     * @param ref - ref to resolve path entries for
-     * @private
-     */
-    private resolvePathEntries;
-    /**
-     * Updates tree entry and associated parent tree entries
-     *
-     * @param existingOid - the existing OID
-     * @param updatedOid - the updated OID
-     * @param path - the path of the entry being updated
-     * @param type - the type of the entry being updated (blob or tree)
-     * @param pathEntries - parent path entries
-     * @param pathParts - parent path parts
-     * @private
-     */
-    private updateTreeHierarchy;
-    /**
-     * Creates a commit for the specified tree and updates the specified ref to point to the commit
-     *
-     * @param treeSha - sha of the new tree
-     * @param ref - the ref that should be updated
-     * @private
-     */
-    private commitTree;
-    private getRef;
-    glob(pattern: string, extension: string): Promise<string[]>;
-    supportsBuilding(): boolean;
-    delete(filepath: string): Promise<void>;
-    private qualifyPath;
-    private unqualifyPath;
-    get(filepath: string): Promise<string>;
-    putConfig(filepath: string, data: string): Promise<void>;
-    put(filepath: string, data: string): Promise<void>;
-}

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

@@ -1,34 +0,0 @@
-/**
-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 { StoreQueryOptions, PutOptions, Store, StoreQueryResponse } from '.';
-export declare class FilesystemStore implements Store {
-    rootPath: string;
-    clear(): Promise<void>;
-    print(): Promise<void>;
-    constructor({ rootPath }: {
-        rootPath?: string;
-    });
-    query(_queryOptions: StoreQueryOptions): Promise<StoreQueryResponse>;
-    seed(): Promise<void>;
-    get<T extends object>(filepath: string): Promise<T>;
-    supportsSeeding(): boolean;
-    supportsIndexing(): boolean;
-    glob(pattern: string, callback: any, extension: any): Promise<any[]>;
-    put(filepath: string, data: object, options?: PutOptions): Promise<void>;
-    open(): Promise<void>;
-    close(): Promise<void>;
-    delete(filepath: any): Promise<void>;
-}
-export declare class AuditFilesystemStore extends FilesystemStore {
-    put(_filepath: string, _data: object): Promise<void>;
-}

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

@@ -1,144 +0,0 @@
-/**
-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 { FilterOperand } from '../../index';
-export declare const DEFAULT_COLLECTION_SORT_KEY = "__filepath__";
-export declare const INDEX_KEY_FIELD_SEPARATOR = "#";
-export declare const DEFAULT_NUMERIC_LPAD = 4;
-export declare enum OP {
-    EQ = "eq",
-    GT = "gt",
-    LT = "lt",
-    GTE = "gte",
-    LTE = "lte",
-    STARTS_WITH = "startsWith",
-    IN = "in"
-}
-export declare type PadDefinition = {
-    fillString: string;
-    maxLength: number;
-};
-export declare type BinaryFilter = {
-    pathExpression: string;
-    rightOperand: FilterOperand;
-    operator: OP.EQ | OP.GT | OP.LT | OP.GTE | OP.LTE | OP.STARTS_WITH | OP.IN;
-    type: string;
-    pad?: PadDefinition;
-};
-export declare type TernaryFilter = {
-    pathExpression: string;
-    leftOperand: FilterOperand;
-    rightOperand: FilterOperand;
-    leftOperator: OP.GTE | OP.GT;
-    rightOperator: OP.LT | OP.LTE;
-    type: string;
-    pad?: PadDefinition;
-};
-/** Options for {@link Store.query} */
-export declare type StoreQueryOptions = {
-    collection: string;
-    indexDefinitions?: Record<string, IndexDefinition>;
-    filterChain: (BinaryFilter | TernaryFilter)[];
-    sort?: string;
-    gt?: string;
-    gte?: string;
-    lt?: string;
-    lte?: string;
-    reverse?: boolean;
-    limit?: number;
-};
-export declare type PageInfo = {
-    hasPreviousPage: boolean;
-    hasNextPage: boolean;
-    startCursor: string;
-    endCursor: string;
-};
-export declare type StoreQueryResponse = {
-    edges: {
-        cursor: string;
-        path: string;
-    }[];
-    pageInfo: PageInfo;
-};
-export declare type IndexDefinition = {
-    fields: {
-        name: string;
-        type?: string;
-        pad?: PadDefinition;
-    }[];
-};
-export declare type SeedOptions = {
-    collection?: string;
-    indexDefinitions?: Record<string, IndexDefinition>;
-    includeTemplate?: boolean;
-    keepTemplateKey?: boolean;
-};
-export declare type PutOptions = SeedOptions & {
-    seed?: boolean;
-};
-export declare type DeleteOptions = SeedOptions & {
-    seed?: boolean;
-};
-export interface Store {
-    glob(pattern: string, hydrator?: (fullPath: string) => Promise<object>, extension?: string): Promise<string[]>;
-    get<T extends object>(filepath: string): Promise<T>;
-    delete(filepath: string, options?: DeleteOptions): Promise<void>;
-    clear(): void;
-    close(): void;
-    open(): void;
-    /**
-     * Executes a query against a collection
-     * @param queryOptions - options for the query
-     * @returns the results of the query
-     */
-    query(queryOptions: StoreQueryOptions): Promise<StoreQueryResponse>;
-    /**
-     * 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?: PutOptions): 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?: PutOptions): Promise<void>;
-}
-export declare type FilterCondition = {
-    filterExpression: Record<string, FilterOperand>;
-    filterPath: string;
-};
-export declare const makeFilterChain: ({ conditions, }: {
-    conditions: FilterCondition[];
-}) => (BinaryFilter | TernaryFilter)[];
-export declare const makeFilter: ({ filterChain, }: {
-    filterChain?: (BinaryFilter | TernaryFilter)[];
-}) => (values: Record<string, object | FilterOperand>) => boolean;
-declare type StringEscaper = <T extends string | string[]>(input: T) => T;
-export declare const makeStringEscaper: (regex: RegExp, replacement: string) => StringEscaper;
-export declare const coerceFilterChainOperands: (filterChain: (BinaryFilter | TernaryFilter)[], stringEscaper: StringEscaper) => (BinaryFilter | TernaryFilter)[];
-export declare const makeFilterSuffixes: (filterChain: (BinaryFilter | TernaryFilter)[], index: IndexDefinition) => {
-    left?: string;
-    right?: string;
-} | undefined;
-export declare const makeKeyForField: (definition: IndexDefinition, data: object, stringEscaper: StringEscaper, maxStringLength?: number) => string | null;
-export {};

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

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

package/dist/database/util.d.ts

@@ -1,16 +0,0 @@
-/**
-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/util.d.ts

@@ -1,28 +0,0 @@
-/**
-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';
-/**
- * Iterate through an array of promises sequentially, ensuring the order
- * is preserved.
- *
- * ```js
- * await sequential(templates, async (template) => {
- *   await doSomething(template)
- * })
- * ```
- */
-export declare const sequential: <A, B>(items: A[], callback: (args: A, idx: number) => Promise<B>) => Promise<B[]>;
-export declare function assertShape<T extends unknown>(value: unknown, yupSchema: (args: typeof yup) => yup.AnySchema, errorMessage?: string): asserts value is T;
-export declare const atob: (b64Encoded: string) => string;
-export declare const btoa: (string: string) => string;
-export declare const lastItem: (arr: (number | string)[]) => string | number;