@firecms/core 3.0.0-alpha.7 → 3.0.0-alpha.71

package/src/types/storage.d.ts

@@ -0,0 +1,82 @@
+/**
+ * @group Models
+ */
+export interface UploadFileProps {
+    file: File;
+    fileName?: string;
+    path?: string;
+    metadata?: any;
+}
+/**
+ * @group Models
+ */
+export interface UploadFileResult {
+    /**
+     * Storage path including the file name where the file was uploaded.
+     */
+    path: string;
+}
+/**
+ * @group Models
+ */
+export interface DownloadConfig {
+    /**
+     * Temporal url that can be used to download the file
+     */
+    url: string | null;
+    metadata?: DownloadMetadata;
+    fileNotFound?: boolean;
+}
+/**
+ * The full set of object metadata, including read-only properties.
+ * @public
+ */
+export declare interface DownloadMetadata {
+    /**
+     * The bucket this object is contained in.
+     */
+    bucket: string;
+    /**
+     * The full path of this object.
+     */
+    fullPath: string;
+    /**
+     * The short name of this object, which is the last component of the full path.
+     * For example, if fullPath is 'full/path/image.png', name is 'image.png'.
+     */
+    name: string;
+    /**
+     * The size of this object, in bytes.
+     */
+    size: number;
+    /**
+     * Type of the uploaded file
+     * e.g. "image/jpeg"
+     */
+    contentType: string;
+    customMetadata: Record<string, unknown>;
+}
+/**
+ * @group Models
+ */
+export interface StorageSource {
+    /**
+     * Upload a file, specifying a name and a path
+     * @param file
+     * @param fileName
+     * @param path
+     * @param metadata
+     */
+    uploadFile: ({ file, fileName, path, metadata }: UploadFileProps) => Promise<UploadFileResult>;
+    /**
+     * Convert a storage path or URL into a download configuration
+     * @param path
+     */
+    getDownloadURL: (pathOrUrl: string) => Promise<DownloadConfig>;
+    /**
+     * Get a file from a storage path.
+     * It returns null if the file does not exist.
+     * @param props
+     */
+    getFile: (path: string) => Promise<File | null>;
+}

package/src/types/storage.ts

@@ -0,0 +1,96 @@
+/**
+ * @group Models
+ */
+export interface UploadFileProps {
+    file: File,
+    fileName?: string,
+    path?: string,
+    metadata?: any,
+}
+
+/**
+ * @group Models
+ */
+export interface UploadFileResult {
+    /**
+     * Storage path including the file name where the file was uploaded.
+     */
+    path: string;
+}
+
+/**
+ * @group Models
+ */
+export interface DownloadConfig {
+    /**
+     * Temporal url that can be used to download the file
+     */
+    url: string | null;
+
+    metadata?: DownloadMetadata;
+
+    fileNotFound?: boolean;
+}
+
+/**
+ * The full set of object metadata, including read-only properties.
+ * @public
+ */
+export declare interface DownloadMetadata {
+    /**
+     * The bucket this object is contained in.
+     */
+    bucket: string;
+    /**
+     * The full path of this object.
+     */
+    fullPath: string;
+    /**
+     * The short name of this object, which is the last component of the full path.
+     * For example, if fullPath is 'full/path/image.png', name is 'image.png'.
+     */
+    name: string;
+    /**
+     * The size of this object, in bytes.
+     */
+    size: number;
+    /**
+     * Type of the uploaded file
+     * e.g. "image/jpeg"
+     */
+    contentType: string;
+
+    customMetadata: Record<string, unknown>;
+}
+
+/**
+ * @group Models
+ */
+export interface StorageSource {
+    /**
+     * Upload a file, specifying a name and a path
+     * @param file
+     * @param fileName
+     * @param path
+     * @param metadata
+     */
+    uploadFile: ({
+                     file,
+                     fileName,
+                     path,
+                     metadata
+                 }: UploadFileProps) => Promise<UploadFileResult>;
+
+    /**
+     * Convert a storage path or URL into a download configuration
+     * @param path
+     */
+    getDownloadURL: (pathOrUrl: string) => Promise<DownloadConfig>;
+
+    /**
+     * Get a file from a storage path.
+     * It returns null if the file does not exist.
+     * @param props
+     */
+    getFile: (path:string) => Promise<File | null>;
+}

package/src/types/user.d.ts

@@ -0,0 +1,36 @@
+/**
+ * This interface represents a user.
+ * It has some of the same fields as a Firebase User.
+ * Note that in the default implementation, we simply take the Firebase user
+ * and use it as a FireCMS user, so that means that even if they are not mapped
+ * in this interface, it contains all the methods of the former, such as `delete`,
+ * `getIdToken`, etc.
+ *
+ * @group Models
+ */
+export type User = {
+    /**
+     * The user's unique ID, scoped to the project.
+     */
+    readonly uid: string;
+    /**
+     * The display name of the user.
+     */
+    readonly displayName: string | null;
+    /**
+     * The email of the user.
+     */
+    readonly email: string | null;
+    /**
+     * The profile photo URL of the user.
+     */
+    readonly photoURL: string | null;
+    /**
+     * The provider used to authenticate the user.
+     */
+    readonly providerId: string;
+    /**
+     *
+     */
+    readonly isAnonymous: boolean;
+};

package/src/types/user.ts

@@ -0,0 +1,37 @@
+/**
+ * This interface represents a user.
+ * It has some of the same fields as a Firebase User.
+ * Note that in the default implementation, we simply take the Firebase user
+ * and use it as a FireCMS user, so that means that even if they are not mapped
+ * in this interface, it contains all the methods of the former, such as `delete`,
+ * `getIdToken`, etc.
+ *
+ * @group Models
+ */
+export type User = {
+    /**
+     * The user's unique ID, scoped to the project.
+     */
+    readonly uid: string;
+    /**
+     * The display name of the user.
+     */
+    readonly displayName: string | null;
+    /**
+     * The email of the user.
+     */
+    readonly email: string | null;
+    /**
+     * The profile photo URL of the user.
+     */
+    readonly photoURL: string | null;
+    /**
+     * The provider used to authenticate the user.
+     */
+    readonly providerId: string;
+    /**
+     *
+     */
+    readonly isAnonymous: boolean;
+
+};

package/src/util/arrays.d.ts

@@ -0,0 +1 @@
+export declare function toArray<T>(input?: T | T[]): T[];

package/src/util/arrays.ts

@@ -0,0 +1,3 @@
+export function toArray<T>(input?: T | T[]): T[] {
+    return Array.isArray(input) ? input : (input ? [input] : []);
+}

package/src/util/builders.d.ts

@@ -0,0 +1,64 @@
+import { AdditionalFieldDelegate, ArrayProperty, BooleanProperty, CMSType, DateProperty, EntityCallbacks, EntityCollection, EnumValueConfig, EnumValues, GeopointProperty, MapProperty, NumberProperty, PropertiesOrBuilders, PropertyBuilder, PropertyConfig, PropertyOrBuilder, ReferenceProperty, StringProperty, User } from "../types";
+/**
+ * Identity function we use to defeat the type system of Typescript and build
+ * collection views with all its properties
+ * @param collection
+ * @group Builder
+ */
+export declare function buildCollection<M extends Record<string, any> = any, UserType extends User = User>(collection: EntityCollection<M, UserType>): EntityCollection<M, UserType>;
+/**
+ * Identity function we use to defeat the type system of Typescript and preserve
+ * the property keys.
+ * @param property
+ * @group Builder
+ */
+export declare function buildProperty<T extends CMSType = CMSType, P extends PropertyOrBuilder<T> = PropertyOrBuilder<T>, M extends Record<string, any> = Record<string, any>>(property: P): P extends StringProperty ? StringProperty : P extends NumberProperty ? NumberProperty : P extends BooleanProperty ? BooleanProperty : P extends DateProperty ? DateProperty : P extends GeopointProperty ? GeopointProperty : P extends ReferenceProperty ? ReferenceProperty : P extends ArrayProperty ? ArrayProperty : P extends MapProperty ? MapProperty : P extends PropertyBuilder<T, M> ? PropertyBuilder<T, M> : never;
+/**
+ * Identity function we use to defeat the type system of Typescript and preserve
+ * the properties keys.
+ * @param properties
+ * @group Builder
+ */
+export declare function buildProperties<M extends Record<string, any>>(properties: PropertiesOrBuilders<M>): PropertiesOrBuilders<M>;
+/**
+ * Identity function we use to defeat the type system of Typescript and preserve
+ * the properties keys.
+ * @param propertiesOrBuilder
+ * @group Builder
+ */
+export declare function buildPropertiesOrBuilder<M extends Record<string, any>>(propertiesOrBuilder: PropertiesOrBuilders<M>): PropertiesOrBuilders<M>;
+/**
+ * Identity function we use to defeat the type system of Typescript and preserve
+ * the properties keys.
+ * @param enumValues
+ * @group Builder
+ */
+export declare function buildEnumValues(enumValues: EnumValues): EnumValues;
+/**
+ * Identity function we use to defeat the type system of Typescript and preserve
+ * the properties keys.
+ * @param enumValueConfig
+ * @group Builder
+ */
+export declare function buildEnumValueConfig(enumValueConfig: EnumValueConfig): EnumValueConfig;
+/**
+ * Identity function we use to defeat the type system of Typescript and preserve
+ * the properties keys.
+ * @param callbacks
+ * @group Builder
+ */
+export declare function buildEntityCallbacks<M extends Record<string, any> = any>(callbacks: EntityCallbacks<M>): EntityCallbacks<M>;
+/**
+ * Identity function we use to defeat the type system of Typescript and build
+ * additional field delegates views with all its properties
+ * @param additionalFieldDelegate
+ * @group Builder
+ */
+export declare function buildAdditionalFieldDelegate<M extends Record<string, any>, UserType extends User = User>(additionalFieldDelegate: AdditionalFieldDelegate<M, UserType>): AdditionalFieldDelegate<M, UserType>;
+/**
+ * Identity function we use to defeat the type system of Typescript and build
+ * additional field delegates views with all its properties
+ * @param propertyConfig
+ * @group Builder
+ */
+export declare function buildFieldConfig<T extends CMSType = CMSType>(propertyConfig: PropertyConfig<T>): PropertyConfig<T>;

package/src/util/builders.ts

@@ -0,0 +1,139 @@
+import {
+    AdditionalFieldDelegate,
+    ArrayProperty,
+    BooleanProperty,
+    CMSType,
+    DateProperty,
+    EntityCallbacks,
+    EntityCollection,
+    EnumValueConfig,
+    EnumValues,
+    GeopointProperty,
+    MapProperty,
+    NumberProperty,
+    PropertiesOrBuilders,
+    PropertyBuilder,
+    PropertyConfig,
+    PropertyOrBuilder,
+    ReferenceProperty,
+    StringProperty,
+    User
+} from "../types";
+
+/**
+ * Identity function we use to defeat the type system of Typescript and build
+ * collection views with all its properties
+ * @param collection
+ * @group Builder
+ */
+export function buildCollection<M extends Record<string, any> = any,
+    UserType extends User = User>(
+    collection: EntityCollection<M, UserType>
+): EntityCollection<M, UserType> {
+    return collection;
+}
+
+/**
+ * Identity function we use to defeat the type system of Typescript and preserve
+ * the property keys.
+ * @param property
+ * @group Builder
+ */
+export function buildProperty<T extends CMSType = CMSType, P extends PropertyOrBuilder<T> = PropertyOrBuilder<T>, M extends Record<string, any> = Record<string, any>>(
+    property: P
+):
+    P extends StringProperty ? StringProperty :
+        P extends NumberProperty ? NumberProperty :
+            P extends BooleanProperty ? BooleanProperty :
+                P extends DateProperty ? DateProperty :
+                    P extends GeopointProperty ? GeopointProperty :
+                        P extends ReferenceProperty ? ReferenceProperty :
+                            P extends ArrayProperty ? ArrayProperty :
+                                P extends MapProperty ? MapProperty :
+                                    P extends PropertyBuilder<T, M> ? PropertyBuilder<T, M> : never {
+    return property as any;
+}
+
+/**
+ * Identity function we use to defeat the type system of Typescript and preserve
+ * the properties keys.
+ * @param properties
+ * @group Builder
+ */
+export function buildProperties<M extends Record<string, any>>(
+    properties: PropertiesOrBuilders<M>
+): PropertiesOrBuilders<M> {
+    return properties;
+}
+
+/**
+ * Identity function we use to defeat the type system of Typescript and preserve
+ * the properties keys.
+ * @param propertiesOrBuilder
+ * @group Builder
+ */
+export function buildPropertiesOrBuilder<M extends Record<string, any>>(
+    propertiesOrBuilder: PropertiesOrBuilders<M>
+): PropertiesOrBuilders<M> {
+    return propertiesOrBuilder;
+}
+
+/**
+ * Identity function we use to defeat the type system of Typescript and preserve
+ * the properties keys.
+ * @param enumValues
+ * @group Builder
+ */
+export function buildEnumValues(
+    enumValues: EnumValues
+): EnumValues {
+    return enumValues;
+}
+
+/**
+ * Identity function we use to defeat the type system of Typescript and preserve
+ * the properties keys.
+ * @param enumValueConfig
+ * @group Builder
+ */
+export function buildEnumValueConfig(
+    enumValueConfig: EnumValueConfig
+): EnumValueConfig {
+    return enumValueConfig;
+}
+
+/**
+ * Identity function we use to defeat the type system of Typescript and preserve
+ * the properties keys.
+ * @param callbacks
+ * @group Builder
+ */
+export function buildEntityCallbacks<M extends Record<string, any> = any>(
+    callbacks: EntityCallbacks<M>
+): EntityCallbacks<M> {
+    return callbacks;
+}
+
+/**
+ * Identity function we use to defeat the type system of Typescript and build
+ * additional field delegates views with all its properties
+ * @param additionalFieldDelegate
+ * @group Builder
+ */
+export function buildAdditionalFieldDelegate<M extends Record<string, any>, UserType extends User = User>(
+    additionalFieldDelegate: AdditionalFieldDelegate<M, UserType>
+): AdditionalFieldDelegate<M, UserType> {
+    return additionalFieldDelegate;
+}
+
+/**
+ * Identity function we use to defeat the type system of Typescript and build
+ * additional field delegates views with all its properties
+ * @param propertyConfig
+ * @group Builder
+ */
+export function buildFieldConfig<T extends CMSType = CMSType>(
+    propertyConfig: PropertyConfig<T>
+): PropertyConfig<T> {
+    return propertyConfig;
+}

package/src/util/chip_utils.d.ts

@@ -0,0 +1,3 @@
+import { ChipColorKey, ChipColorScheme } from "@firecms/ui";
+export declare function getColorSchemeForSeed(seed: string): ChipColorScheme;
+export declare function getColorSchemeForKey(key: ChipColorKey): ChipColorScheme;

package/src/util/chip_utils.ts

@@ -0,0 +1,13 @@
+import { hashString } from "./hash";
+import { CHIP_COLORS, ChipColorKey, ChipColorScheme } from "@firecms/ui";
+
+export function getColorSchemeForSeed(seed: string): ChipColorScheme {
+    const hash: number = hashString(seed);
+    const colorKeys = Object.keys(CHIP_COLORS);
+    const index = hash % colorKeys.length;
+    return CHIP_COLORS[colorKeys[index]];
+}
+
+export function getColorSchemeForKey(key: ChipColorKey): ChipColorScheme {
+    return CHIP_COLORS[key];
+}

package/src/util/collections.d.ts

@@ -0,0 +1,3 @@
+import { DefaultSelectedViewBuilder, DefaultSelectedViewParams, PropertiesOrBuilders } from "../types";
+export declare function sortProperties<M extends Record<string, any>>(properties: PropertiesOrBuilders<M>, propertiesOrder?: (keyof M)[]): PropertiesOrBuilders<M>;
+export declare function resolveDefaultSelectedView(defaultSelectedView: string | DefaultSelectedViewBuilder | undefined, params: DefaultSelectedViewParams): string | undefined;

package/src/util/collections.ts

@@ -0,0 +1,50 @@
+import {
+    DefaultSelectedViewBuilder,
+    DefaultSelectedViewParams,
+    PropertiesOrBuilders,
+    PropertyOrBuilder
+} from "../types";
+import { isPropertyBuilder } from "./entities";
+
+export function sortProperties<M extends Record<string, any>>(properties: PropertiesOrBuilders<M>, propertiesOrder?: (keyof M)[]): PropertiesOrBuilders<M> {
+    try {
+        const propertiesKeys = Object.keys(properties);
+        const allPropertiesOrder = propertiesOrder ?? propertiesKeys;
+        return allPropertiesOrder
+            .map((key) => {
+                if (properties[key as keyof M]) {
+                    const property = properties[key] as PropertyOrBuilder;
+                    if (!isPropertyBuilder(property) && property?.dataType === "map" && property.properties) {
+                        return ({
+                            [key]: {
+                                ...property,
+                                properties: sortProperties(property.properties, property.propertiesOrder)
+                            }
+                        });
+                    } else {
+                        return ({ [key]: property });
+                    }
+                } else {
+                    return undefined;
+                }
+            })
+            .filter((a) => a !== undefined)
+            .reduce((a: any, b: any) => ({ ...a, ...b }), {}) as PropertiesOrBuilders<M>;
+    } catch (e) {
+        console.error("Error sorting properties", e);
+        return properties;
+    }
+}
+
+export function resolveDefaultSelectedView(
+    defaultSelectedView: string | DefaultSelectedViewBuilder | undefined,
+    params: DefaultSelectedViewParams
+) {
+    if (!defaultSelectedView) {
+        return undefined;
+    } else if (typeof defaultSelectedView === "string") {
+        return defaultSelectedView;
+    } else {
+        return defaultSelectedView(params);
+    }
+}

package/src/util/common.d.ts

@@ -0,0 +1,2 @@
+export declare const DEFAULT_ONE_OF_TYPE = "type";
+export declare const DEFAULT_ONE_OF_VALUE = "value";

package/src/util/common.tsx

@@ -0,0 +1,2 @@
+export const DEFAULT_ONE_OF_TYPE = "type"
+export const DEFAULT_ONE_OF_VALUE = "value"

package/src/util/dates.d.ts

@@ -0,0 +1 @@
+export declare const defaultDateFormat = "MMMM dd, yyyy, HH:mm:ss";

package/src/util/dates.ts

@@ -0,0 +1 @@
+export const defaultDateFormat = "MMMM dd, yyyy, HH:mm:ss";

package/src/util/entities.d.ts

@@ -0,0 +1,28 @@
+import { CMSType, DataType, Entity, EntityReference, EntityStatus, EntityValues, PropertiesOrBuilders, Property, PropertyBuilder, PropertyOrBuilder, ResolvedProperties, ResolvedProperty } from "../types";
+export declare function isReadOnly(property: Property | ResolvedProperty): boolean;
+export declare function isHidden(property: Property | ResolvedProperty): boolean;
+export declare function isPropertyBuilder<T extends CMSType, M extends Record<string, any>>(propertyOrBuilder?: PropertyOrBuilder<T, M> | Property<T> | ResolvedProperty<T>): propertyOrBuilder is PropertyBuilder<T, M>;
+export declare function getDefaultValuesFor<M extends Record<string, any>>(properties: PropertiesOrBuilders<M> | ResolvedProperties<M>): Partial<EntityValues<M>>;
+export declare function getDefaultValueFor(property: PropertyOrBuilder): {} | null | undefined;
+export declare function getDefaultValueForDataType(dataType: DataType): {} | null;
+/**
+ * Update the automatic values in an entity before save
+ * @group Datasource
+ */
+export declare function updateDateAutoValues<M extends Record<string, any>>({ inputValues, properties, status, timestampNowValue, setDateToMidnight }: {
+    inputValues: Partial<EntityValues<M>>;
+    properties: ResolvedProperties<M>;
+    status: EntityStatus;
+    timestampNowValue: any;
+    setDateToMidnight: (input?: any) => any | undefined;
+}): EntityValues<M>;
+/**
+ * Add missing required fields, expected in the collection, to the values of an entity
+ * @param values
+ * @param properties
+ * @group Datasource
+ */
+export declare function sanitizeData<M extends Record<string, any>>(values: EntityValues<M>, properties: ResolvedProperties<M>): any;
+export declare function getReferenceFrom<M extends Record<string, any>>(entity: Entity<M>): EntityReference<M>;
+export declare function traverseValuesProperties<M extends Record<string, any>>(inputValues: Partial<EntityValues<M>>, properties: ResolvedProperties<M>, operation: (value: any, property: Property) => any): EntityValues<M> | undefined;
+export declare function traverseValueProperty(inputValue: any, property: Property, operation: (value: any, property: Property) => any): any;