@verdant-web/common 1.15.2 → 1.15.3-next.0

package/dist/esm/schema/fields.js

@@ -1,134 +1,134 @@
-import { LEGACY_OID_KEY, OID_KEY } from '../oids.js';
-import { isObject } from '../utils.js';
-export function isNullable(field) {
-    if (field.type === 'any')
-        return true;
-    if (field.type === 'map')
-        return false;
-    return field.nullable;
-}
-export function hasDefault(field) {
-    if (!field)
-        return false;
-    if (field.type === 'map')
-        return true;
-    if (field.type === 'array')
-        return true;
-    if (field.type === 'file')
-        return false;
-    if (field.type === 'object')
-        return true;
-    return field.default !== undefined;
-}
-export function isIndexed(field) {
-    if (field.type === 'map')
-        return false;
-    if (field.type === 'object')
-        return false;
-    if (field.type === 'array')
-        return false;
-    if (field.type === 'file')
-        return false;
-    if (field.type === 'any')
-        return false;
-    return field.indexed;
-}
-export function addFieldDefaults(collection, value) {
-    for (const [key, field] of Object.entries(collection.fields)) {
-        const defaultValue = getFieldDefault(field);
-        if ((defaultValue !== undefined && value[key] === undefined) ||
-            // covers the case where a previously nullable field
-            // now has a default during a new migration
-            (!isNullable(field) && value[key] === null)) {
-            value[key] = defaultValue;
-        }
-        if (value[key]) {
-            traverseCollectionFieldsAndApplyDefaults(value[key], field);
-        }
-    }
-    return value;
-}
-export function traverseCollectionFieldsAndApplyDefaults(value, field) {
-    if (value === undefined || value === null)
-        return value;
-    if (field.type === 'object') {
-        for (const [key, subField] of Object.entries(field.properties)) {
-            if (value[key] === undefined) {
-                const defaultValue = getFieldDefault(subField);
-                if (defaultValue !== undefined) {
-                    value[key] = defaultValue;
-                }
-            }
-            traverseCollectionFieldsAndApplyDefaults(value[key], subField);
-        }
-    }
-    else if (field.type === 'array') {
-        for (const item of value) {
-            traverseCollectionFieldsAndApplyDefaults(item, field.items);
-        }
-    }
-    else if (field.type === 'map') {
-        for (const [key, item] of Object.entries(value)) {
-            // santiy check to weed out any id field
-            if (key === OID_KEY || key === LEGACY_OID_KEY)
-                continue;
-            traverseCollectionFieldsAndApplyDefaults(item, field.values);
-        }
-    }
-}
-export function getFieldDefault(field) {
-    if (field.type === 'string' ||
-        field.type === 'number' ||
-        field.type === 'boolean' ||
-        field.type === 'any') {
-        if (field.default && typeof field.default === 'function') {
-            return field.default();
-        }
-        else if (field.default !== undefined) {
-            // TODO: structuredClone?
-            return JSON.parse(JSON.stringify(field.default));
-        }
-    }
-    if (field.type === 'array') {
-        return [];
-    }
-    if (field.type === 'map') {
-        return {};
-    }
-    if (field.type !== 'any' && field.nullable) {
-        return null;
-    }
-    return undefined;
-}
-export function removeExtraProperties(collection, value) {
-    for (const [key, fieldValue] of Object.entries(value)) {
-        // MUST NOT DELETE THESE!
-        if (key === OID_KEY || key === LEGACY_OID_KEY)
-            continue;
-        if (!collection.fields[key]) {
-            delete value[key];
-        }
-        else {
-            traverseCollectionFieldsAndRemoveExtraProperties(fieldValue, collection.fields[key]);
-        }
-    }
-    return value;
-}
-export function traverseCollectionFieldsAndRemoveExtraProperties(value, field) {
-    if (isObject(value) && field.type === 'object') {
-        for (const [key, fieldValue] of Object.entries(value)) {
-            if (!field.properties[key]) {
-                delete value[key];
-            }
-            else {
-                traverseCollectionFieldsAndRemoveExtraProperties(fieldValue, field.properties[key]);
-            }
-        }
-    }
-    else if (Array.isArray(value) && field.type === 'array') {
-        for (const item of value) {
-            traverseCollectionFieldsAndRemoveExtraProperties(item, field.items);
-        }
-    }
-}
+import { LEGACY_OID_KEY, OID_KEY } from '../oids.js';
+import { isObject } from '../utils.js';
+export function isNullable(field) {
+    if (field.type === 'any')
+        return true;
+    if (field.type === 'map')
+        return false;
+    return field.nullable;
+}
+export function hasDefault(field) {
+    if (!field)
+        return false;
+    if (field.type === 'map')
+        return true;
+    if (field.type === 'array')
+        return true;
+    if (field.type === 'file')
+        return false;
+    if (field.type === 'object')
+        return true;
+    return field.default !== undefined;
+}
+export function isIndexed(field) {
+    if (field.type === 'map')
+        return false;
+    if (field.type === 'object')
+        return false;
+    if (field.type === 'array')
+        return false;
+    if (field.type === 'file')
+        return false;
+    if (field.type === 'any')
+        return false;
+    return field.indexed;
+}
+export function addFieldDefaults(collection, value) {
+    for (const [key, field] of Object.entries(collection.fields)) {
+        const defaultValue = getFieldDefault(field);
+        if ((defaultValue !== undefined && value[key] === undefined) ||
+            // covers the case where a previously nullable field
+            // now has a default during a new migration
+            (!isNullable(field) && value[key] === null)) {
+            value[key] = defaultValue;
+        }
+        if (value[key]) {
+            traverseCollectionFieldsAndApplyDefaults(value[key], field);
+        }
+    }
+    return value;
+}
+export function traverseCollectionFieldsAndApplyDefaults(value, field) {
+    if (value === undefined || value === null)
+        return value;
+    if (field.type === 'object') {
+        for (const [key, subField] of Object.entries(field.properties)) {
+            if (value[key] === undefined) {
+                const defaultValue = getFieldDefault(subField);
+                if (defaultValue !== undefined) {
+                    value[key] = defaultValue;
+                }
+            }
+            traverseCollectionFieldsAndApplyDefaults(value[key], subField);
+        }
+    }
+    else if (field.type === 'array') {
+        for (const item of value) {
+            traverseCollectionFieldsAndApplyDefaults(item, field.items);
+        }
+    }
+    else if (field.type === 'map') {
+        for (const [key, item] of Object.entries(value)) {
+            // santiy check to weed out any id field
+            if (key === OID_KEY || key === LEGACY_OID_KEY)
+                continue;
+            traverseCollectionFieldsAndApplyDefaults(item, field.values);
+        }
+    }
+}
+export function getFieldDefault(field) {
+    if (field.type === 'string' ||
+        field.type === 'number' ||
+        field.type === 'boolean' ||
+        field.type === 'any') {
+        if (field.default && typeof field.default === 'function') {
+            return field.default();
+        }
+        else if (field.default !== undefined) {
+            // TODO: structuredClone?
+            return JSON.parse(JSON.stringify(field.default));
+        }
+    }
+    if (field.type === 'array') {
+        return [];
+    }
+    if (field.type === 'map') {
+        return {};
+    }
+    if (field.type !== 'any' && field.nullable) {
+        return null;
+    }
+    return undefined;
+}
+export function removeExtraProperties(collection, value) {
+    for (const [key, fieldValue] of Object.entries(value)) {
+        // MUST NOT DELETE THESE!
+        if (key === OID_KEY || key === LEGACY_OID_KEY)
+            continue;
+        if (!collection.fields[key]) {
+            delete value[key];
+        }
+        else {
+            traverseCollectionFieldsAndRemoveExtraProperties(fieldValue, collection.fields[key]);
+        }
+    }
+    return value;
+}
+export function traverseCollectionFieldsAndRemoveExtraProperties(value, field) {
+    if (isObject(value) && field.type === 'object') {
+        for (const [key, fieldValue] of Object.entries(value)) {
+            if (!field.properties[key]) {
+                delete value[key];
+            }
+            else {
+                traverseCollectionFieldsAndRemoveExtraProperties(fieldValue, field.properties[key]);
+            }
+        }
+    }
+    else if (Array.isArray(value) && field.type === 'array') {
+        for (const item of value) {
+            traverseCollectionFieldsAndRemoveExtraProperties(item, field.items);
+        }
+    }
+}
 //# sourceMappingURL=fields.js.map

package/dist/esm/schema/index.d.ts

@@ -1,8 +1,8 @@
-import { CollectionCompoundIndices, StorageCollectionSchema, StorageFieldsSchema, StorageSchema, StorageSyntheticIndices } from './types.js';
-export declare function collection<Fields extends StorageFieldsSchema, Synthetics extends StorageSyntheticIndices<Fields>, Compounds extends CollectionCompoundIndices<Fields, Synthetics>>({ synthetics, indexes, ...input }: StorageCollectionSchema<Fields, Synthetics, Compounds>): StorageCollectionSchema<Fields, Synthetics, Compounds>;
-export declare function schema<Schema extends StorageSchema<{
-    [key: string]: StorageCollectionSchema<any, any, any>;
-}>>(input: Schema): StorageSchema;
-export * from './types.js';
-export * from './indexFilters.js';
-export * from './fields.js';
+import { CollectionCompoundIndices, StorageCollectionSchema, StorageFieldsSchema, StorageSchema, StorageSyntheticIndices } from './types.js';
+export declare function collection<Fields extends StorageFieldsSchema, Synthetics extends StorageSyntheticIndices<Fields>, Compounds extends CollectionCompoundIndices<Fields, Synthetics>>({ synthetics, indexes, ...input }: StorageCollectionSchema<Fields, Synthetics, Compounds>): StorageCollectionSchema<Fields, Synthetics, Compounds>;
+export declare function schema<Schema extends StorageSchema<{
+    [key: string]: StorageCollectionSchema<any, any, any>;
+}>>(input: Schema): StorageSchema;
+export * from './types.js';
+export * from './indexFilters.js';
+export * from './fields.js';

package/dist/esm/schema/index.js

@@ -1,33 +1,33 @@
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-import { isIndexed } from './fields.js';
-export function collection(_a) {
-    var { synthetics, indexes } = _a, input = __rest(_a, ["synthetics", "indexes"]);
-    // back compat - copy synthetics in with indexes
-    const finalIndexes = Object.assign(Object.assign({}, synthetics), indexes);
-    // add all indexed fields into the synthetic indices (back compat)
-    for (const [key, field] of Object.entries(input.fields)) {
-        if (isIndexed(field)) {
-            finalIndexes[key] = {
-                field: key,
-            };
-        }
-    }
-    return Object.assign(Object.assign({}, input), { indexes: finalIndexes });
-}
-export function schema(input) {
-    return input;
-}
-export * from './types.js';
-export * from './indexFilters.js';
-export * from './fields.js';
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { isIndexed } from './fields.js';
+export function collection(_a) {
+    var { synthetics, indexes } = _a, input = __rest(_a, ["synthetics", "indexes"]);
+    // back compat - copy synthetics in with indexes
+    const finalIndexes = Object.assign(Object.assign({}, synthetics), indexes);
+    // add all indexed fields into the synthetic indices (back compat)
+    for (const [key, field] of Object.entries(input.fields)) {
+        if (isIndexed(field)) {
+            finalIndexes[key] = {
+                field: key,
+            };
+        }
+    }
+    return Object.assign(Object.assign({}, input), { indexes: finalIndexes });
+}
+export function schema(input) {
+    return input;
+}
+export * from './types.js';
+export * from './indexFilters.js';
+export * from './fields.js';
 //# sourceMappingURL=index.js.map

package/dist/esm/schema/indexFilters.d.ts

@@ -1,6 +1,6 @@
-import { CollectionCompoundIndexFilter, CollectionFilter, MatchCollectionIndexFilter, RangeCollectionIndexFilter, SortIndexFilter, StartsWithIndexFilter } from './types.js';
-export declare function isMatchIndexFilter(filter: CollectionFilter): filter is MatchCollectionIndexFilter;
-export declare function isRangeIndexFilter(filter: CollectionFilter): filter is RangeCollectionIndexFilter;
-export declare function isCompoundIndexFilter(filter: CollectionFilter): filter is CollectionCompoundIndexFilter;
-export declare function isStartsWithIndexFilter(filter: CollectionFilter): filter is StartsWithIndexFilter;
-export declare function isSortIndexFilter(filter: CollectionFilter): filter is SortIndexFilter;
+import { CollectionCompoundIndexFilter, CollectionFilter, MatchCollectionIndexFilter, RangeCollectionIndexFilter, SortIndexFilter, StartsWithIndexFilter } from './types.js';
+export declare function isMatchIndexFilter(filter: CollectionFilter): filter is MatchCollectionIndexFilter;
+export declare function isRangeIndexFilter(filter: CollectionFilter): filter is RangeCollectionIndexFilter;
+export declare function isCompoundIndexFilter(filter: CollectionFilter): filter is CollectionCompoundIndexFilter;
+export declare function isStartsWithIndexFilter(filter: CollectionFilter): filter is StartsWithIndexFilter;
+export declare function isSortIndexFilter(filter: CollectionFilter): filter is SortIndexFilter;

package/dist/esm/schema/indexFilters.js

@@ -1,23 +1,23 @@
-export function isMatchIndexFilter(filter) {
-    return filter.equals !== undefined;
-}
-export function isRangeIndexFilter(filter) {
-    return (filter.gte !== undefined ||
-        filter.lte !== undefined ||
-        filter.gt !== undefined ||
-        filter.lt !== undefined);
-}
-export function isCompoundIndexFilter(filter) {
-    return !!filter.match;
-}
-export function isStartsWithIndexFilter(filter) {
-    return filter.startsWith !== undefined;
-}
-export function isSortIndexFilter(filter) {
-    return (!isRangeIndexFilter(filter) &&
-        !isMatchIndexFilter(filter) &&
-        !isCompoundIndexFilter(filter) &&
-        !isStartsWithIndexFilter(filter) &&
-        filter.order);
-}
+export function isMatchIndexFilter(filter) {
+    return filter.equals !== undefined;
+}
+export function isRangeIndexFilter(filter) {
+    return (filter.gte !== undefined ||
+        filter.lte !== undefined ||
+        filter.gt !== undefined ||
+        filter.lt !== undefined);
+}
+export function isCompoundIndexFilter(filter) {
+    return !!filter.match;
+}
+export function isStartsWithIndexFilter(filter) {
+    return filter.startsWith !== undefined;
+}
+export function isSortIndexFilter(filter) {
+    return (!isRangeIndexFilter(filter) &&
+        !isMatchIndexFilter(filter) &&
+        !isCompoundIndexFilter(filter) &&
+        !isStartsWithIndexFilter(filter) &&
+        filter.order);
+}
 //# sourceMappingURL=indexFilters.js.map

package/dist/esm/schema/types/collection.d.ts

@@ -1,23 +1,23 @@
-import { CollectionCompoundIndices } from './compounds.js';
-import { StorageFieldsSchema } from './fields.js';
-import { DirectIndexableFieldName, StorageSyntheticIndices } from './synthetics.js';
-/**
- * The main collection schema
- */
-export declare type StorageCollectionSchema<Fields extends StorageFieldsSchema = StorageFieldsSchema, Synthetics extends StorageSyntheticIndices<Fields> = StorageSyntheticIndices<Fields>, Compounds extends CollectionCompoundIndices<Fields, Synthetics> = CollectionCompoundIndices<Fields, Synthetics>> = {
-    name: string;
-    /**
-     * Your primary key must be a string, number, or boolean field. It must also
-     * not be rewritten.
-     */
-    primaryKey: DirectIndexableFieldName<Fields>;
-    fields: Fields;
-    indexes?: Synthetics;
-    compounds?: Compounds;
-    /**
-     * @deprecated - plural name is the key used to index this collection in the schema. this field is no longer used.
-     */
-    pluralName?: string;
-    /** @deprecated - use "indexes" */
-    synthetics?: Synthetics;
-};
+import { CollectionCompoundIndices } from './compounds.js';
+import { StorageFieldsSchema } from './fields.js';
+import { DirectIndexableFieldName, StorageSyntheticIndices } from './synthetics.js';
+/**
+ * The main collection schema
+ */
+export declare type StorageCollectionSchema<Fields extends StorageFieldsSchema = StorageFieldsSchema, Synthetics extends StorageSyntheticIndices<Fields> = StorageSyntheticIndices<Fields>, Compounds extends CollectionCompoundIndices<Fields, Synthetics> = CollectionCompoundIndices<Fields, Synthetics>> = {
+    name: string;
+    /**
+     * Your primary key must be a string, number, or boolean field. It must also
+     * not be rewritten.
+     */
+    primaryKey: DirectIndexableFieldName<Fields>;
+    fields: Fields;
+    indexes?: Synthetics;
+    compounds?: Compounds;
+    /**
+     * @deprecated - plural name is the key used to index this collection in the schema. this field is no longer used.
+     */
+    pluralName?: string;
+    /** @deprecated - use "indexes" */
+    synthetics?: Synthetics;
+};

package/dist/esm/schema/types/collection.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=collection.js.map

package/dist/esm/schema/types/compounds.d.ts

@@ -1,11 +1,11 @@
-import { NestedStorageBooleanFieldSchema, NestedStorageNumberFieldSchema, NestedStorageStringFieldSchema, StorageArrayFieldSchema, StorageFieldsSchema } from './fields.js';
-import { DirectIndexableFieldName, StorageSyntheticIndices } from './synthetics.js';
-declare type PrimitiveArrayFields<Fields extends StorageFieldsSchema> = {
-    [K in keyof Fields as Fields[K] extends StorageArrayFieldSchema ? Fields[K]['items'] extends NestedStorageStringFieldSchema | NestedStorageNumberFieldSchema | NestedStorageBooleanFieldSchema ? K : never : never]: Fields[K];
-};
-declare type PrimitiveArrayFieldName<Fields extends StorageFieldsSchema> = Extract<keyof PrimitiveArrayFields<Fields>, string>;
-export declare type CollectionCompoundIndex<Fields extends StorageFieldsSchema, Synthetics extends StorageSyntheticIndices<Fields>> = {
-    of: (DirectIndexableFieldName<Fields> | PrimitiveArrayFieldName<Fields> | Extract<keyof Synthetics, string>)[];
-};
-export declare type CollectionCompoundIndices<Fields extends StorageFieldsSchema, Synthetics extends StorageSyntheticIndices<Fields>> = Record<string, CollectionCompoundIndex<Fields, Synthetics>>;
-export {};
+import { NestedStorageBooleanFieldSchema, NestedStorageNumberFieldSchema, NestedStorageStringFieldSchema, StorageArrayFieldSchema, StorageFieldsSchema } from './fields.js';
+import { DirectIndexableFieldName, StorageSyntheticIndices } from './synthetics.js';
+declare type PrimitiveArrayFields<Fields extends StorageFieldsSchema> = {
+    [K in keyof Fields as Fields[K] extends StorageArrayFieldSchema ? Fields[K]['items'] extends NestedStorageStringFieldSchema | NestedStorageNumberFieldSchema | NestedStorageBooleanFieldSchema ? K : never : never]: Fields[K];
+};
+declare type PrimitiveArrayFieldName<Fields extends StorageFieldsSchema> = Extract<keyof PrimitiveArrayFields<Fields>, string>;
+export declare type CollectionCompoundIndex<Fields extends StorageFieldsSchema, Synthetics extends StorageSyntheticIndices<Fields>> = {
+    of: (DirectIndexableFieldName<Fields> | PrimitiveArrayFieldName<Fields> | Extract<keyof Synthetics, string>)[];
+};
+export declare type CollectionCompoundIndices<Fields extends StorageFieldsSchema, Synthetics extends StorageSyntheticIndices<Fields>> = Record<string, CollectionCompoundIndex<Fields, Synthetics>>;
+export {};

package/dist/esm/schema/types/compounds.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=compounds.js.map

package/dist/esm/schema/types/fields.d.ts

@@ -1,75 +1,75 @@
-export declare type StorageStringFieldSchema = {
-    type: 'string';
-    /** @deprecated - add an index to indexes with this field name. */
-    indexed?: boolean;
-    nullable?: boolean;
-    default?: string | (() => string);
-};
-export declare type StorageNumberFieldSchema = {
-    type: 'number';
-    /** @deprecated - add an index to indexes with this field name. */
-    indexed?: boolean;
-    nullable?: boolean;
-    default?: number | (() => number);
-};
-export declare type StorageBooleanFieldSchema = {
-    type: 'boolean';
-    nullable?: boolean;
-    default?: boolean | (() => boolean);
-    /** @deprecated - add an index to indexes with this field name. */
-    indexed?: boolean;
-};
-export declare type StorageArrayFieldSchema = {
-    type: 'array';
-    items: NestedStorageFieldSchema;
-    nullable?: boolean;
-};
-export declare type StorageObjectFieldSchema = {
-    type: 'object';
-    properties: NestedStorageFieldsSchema;
-    nullable?: boolean;
-};
-export declare type StorageAnyFieldSchema = {
-    type: 'any';
-    default?: any;
-};
-export declare type StorageMapFieldSchema<V extends NestedStorageFieldSchema> = {
-    type: 'map';
-    values: V;
-};
-export declare type StorageFileFieldSchema = {
-    type: 'file';
-    nullable?: boolean;
-    /**
-     * Instructs the client to download synced files to local storage on first request for offline use.
-     * Leave this false to save storage space on the client, at the cost of requiring a network
-     * connection to use files created by other devices.
-     */
-    downloadRemote?: boolean;
-};
-export declare type StorageFieldSchema = StorageStringFieldSchema | StorageNumberFieldSchema | StorageBooleanFieldSchema | StorageArrayFieldSchema | StorageObjectFieldSchema | StorageAnyFieldSchema | StorageMapFieldSchema<any> | StorageFileFieldSchema;
-export declare type NestedStorageStringFieldSchema = {
-    type: 'string';
-    nullable?: boolean;
-    default?: string | (() => string);
-};
-export declare type NestedStorageNumberFieldSchema = {
-    type: 'number';
-    nullable?: boolean;
-    default?: number | (() => number);
-};
-export declare type NestedStorageBooleanFieldSchema = {
-    type: 'boolean';
-    nullable?: boolean;
-    default: boolean | (() => boolean);
-};
-export declare type NestedStorageFieldSchema = NestedStorageStringFieldSchema | NestedStorageNumberFieldSchema | NestedStorageBooleanFieldSchema | StorageArrayFieldSchema | StorageObjectFieldSchema | StorageAnyFieldSchema | StorageMapFieldSchema<any> | StorageFileFieldSchema;
-export declare type StorageFieldsSchema = {
-    [key: string]: StorageFieldSchema;
-};
-export declare type NestedStorageFieldsSchema = Record<string, NestedStorageFieldSchema>;
-export declare type StorageIndexableFields<Fields extends StorageFieldsSchema> = {
-    [K in keyof Fields]: Fields[K] extends {
-        indexed: boolean;
-    } ? K : never;
-};
+export declare type StorageStringFieldSchema = {
+    type: 'string';
+    /** @deprecated - add an index to indexes with this field name. */
+    indexed?: boolean;
+    nullable?: boolean;
+    default?: string | (() => string);
+};
+export declare type StorageNumberFieldSchema = {
+    type: 'number';
+    /** @deprecated - add an index to indexes with this field name. */
+    indexed?: boolean;
+    nullable?: boolean;
+    default?: number | (() => number);
+};
+export declare type StorageBooleanFieldSchema = {
+    type: 'boolean';
+    nullable?: boolean;
+    default?: boolean | (() => boolean);
+    /** @deprecated - add an index to indexes with this field name. */
+    indexed?: boolean;
+};
+export declare type StorageArrayFieldSchema = {
+    type: 'array';
+    items: NestedStorageFieldSchema;
+    nullable?: boolean;
+};
+export declare type StorageObjectFieldSchema = {
+    type: 'object';
+    properties: NestedStorageFieldsSchema;
+    nullable?: boolean;
+};
+export declare type StorageAnyFieldSchema = {
+    type: 'any';
+    default?: any;
+};
+export declare type StorageMapFieldSchema<V extends NestedStorageFieldSchema> = {
+    type: 'map';
+    values: V;
+};
+export declare type StorageFileFieldSchema = {
+    type: 'file';
+    nullable?: boolean;
+    /**
+     * Instructs the client to download synced files to local storage on first request for offline use.
+     * Leave this false to save storage space on the client, at the cost of requiring a network
+     * connection to use files created by other devices.
+     */
+    downloadRemote?: boolean;
+};
+export declare type StorageFieldSchema = StorageStringFieldSchema | StorageNumberFieldSchema | StorageBooleanFieldSchema | StorageArrayFieldSchema | StorageObjectFieldSchema | StorageAnyFieldSchema | StorageMapFieldSchema<any> | StorageFileFieldSchema;
+export declare type NestedStorageStringFieldSchema = {
+    type: 'string';
+    nullable?: boolean;
+    default?: string | (() => string);
+};
+export declare type NestedStorageNumberFieldSchema = {
+    type: 'number';
+    nullable?: boolean;
+    default?: number | (() => number);
+};
+export declare type NestedStorageBooleanFieldSchema = {
+    type: 'boolean';
+    nullable?: boolean;
+    default: boolean | (() => boolean);
+};
+export declare type NestedStorageFieldSchema = NestedStorageStringFieldSchema | NestedStorageNumberFieldSchema | NestedStorageBooleanFieldSchema | StorageArrayFieldSchema | StorageObjectFieldSchema | StorageAnyFieldSchema | StorageMapFieldSchema<any> | StorageFileFieldSchema;
+export declare type StorageFieldsSchema = {
+    [key: string]: StorageFieldSchema;
+};
+export declare type NestedStorageFieldsSchema = Record<string, NestedStorageFieldSchema>;
+export declare type StorageIndexableFields<Fields extends StorageFieldsSchema> = {
+    [K in keyof Fields]: Fields[K] extends {
+        indexed: boolean;
+    } ? K : never;
+};

package/dist/esm/schema/types/fields.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=fields.js.map