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

package/src/types/property_config.d.ts

@@ -0,0 +1,42 @@
+import React from "react";
+import { CMSType, PropertyOrBuilder } from "./properties";
+/**
+ * This is the configuration object for a property.
+ * These configs are generated by default for the properties defined in your
+ * collections' configuration, but you can define your own to be used.
+ */
+export type PropertyConfig<T extends CMSType = any> = {
+    /**
+     * Key used to identify this property config.
+     */
+    key: string;
+    /**
+     * Name of this field type.
+     * This is not the name of the property.
+     */
+    name: string;
+    /**
+     * Default config for the property.
+     * This property or builder will be used as the base values for the resulting property.
+     * You can also use a builder function to generate the base property.
+     * You can use a builder function to generate the property based on the values or the path.
+     * You can also define a custom Field as a React component to be used for this property.
+     */
+    property: PropertyOrBuilder<T>;
+    /**
+     * Optional icon to be used in the field selector.
+     * Use a 24x24 component, in order not to break the layout.
+     * Any FireCMS icon can be used.
+     */
+    Icon?: React.ComponentType;
+    /**
+     * CSS color, used only in some plugins like the field selector.
+     * e.g. "#2d7ff9"
+     */
+    color?: string;
+    /**
+     * Description of this field type.
+     */
+    description?: string;
+};
+export type FieldConfigId = "text_field" | "multiline" | "markdown" | "url" | "email" | "select" | "multi_select" | "number_input" | "number_select" | "multi_number_select" | "file_upload" | "multi_file_upload" | "group" | "key_value" | "reference" | "multi_references" | "switch" | "date_time" | "repeat" | "custom_array" | "block";

package/src/types/resolved_entities.d.ts

@@ -0,0 +1,98 @@
+import { ArrayProperty, BooleanProperty, CMSType, DateProperty, EnumValueConfig, GeopointProperty, MapProperty, NumberProperty, ReferenceProperty, StringProperty } from "./properties";
+import { EntityReference, GeoPoint } from "./entities";
+import { EntityCollection } from "./collections";
+/**
+ * This is the same entity collection you define, only all the property builders
+ * are resolved to regular `Property` objects.
+ * @group Models
+ */
+export type ResolvedEntityCollection<M extends Record<string, any> = any> = Omit<EntityCollection<M>, "properties"> & {
+    properties: ResolvedProperties<M>;
+    originalCollection: EntityCollection<M>;
+    editable?: boolean;
+};
+/**
+ * @group Entity properties
+ */
+export type ResolvedProperty<T extends CMSType = CMSType> = T extends string ? ResolvedStringProperty : T extends number ? ResolvedNumberProperty : T extends boolean ? ResolvedBooleanProperty : T extends Date ? ResolvedTimestampProperty : T extends GeoPoint ? ResolvedGeopointProperty : T extends EntityReference ? ResolvedReferenceProperty : T extends CMSType[] ? ResolvedArrayProperty<T> : T extends Record<string, any> ? ResolvedMapProperty<T> : any;
+/**
+ * @group Entity properties
+ */
+export type ResolvedProperties<M extends Record<string, any> = any> = {
+    [k in keyof M]: ResolvedProperty<M[keyof M]>;
+};
+/**
+ * @group Entity properties
+ */
+export type ResolvedStringProperty = Omit<StringProperty, "enumValues" | "dataType"> & {
+    dataType: "string";
+    resolved: true;
+    enumValues?: EnumValueConfig[];
+    fromBuilder: boolean;
+};
+/**
+ * @group Entity properties
+ */
+export type ResolvedNumberProperty = Omit<NumberProperty, "enumValues" | "dataType"> & {
+    dataType: "number";
+    resolved: true;
+    enumValues?: EnumValueConfig[];
+    fromBuilder: boolean;
+};
+/**
+ * @group Entity properties
+ */
+export type ResolvedBooleanProperty = Omit<BooleanProperty, "dataType"> & {
+    dataType: "boolean";
+    resolved: true;
+    fromBuilder: boolean;
+};
+/**
+ * @group Entity properties
+ */
+export type ResolvedTimestampProperty = Omit<DateProperty, "dataType"> & {
+    dataType: "date";
+    resolved: true;
+    fromBuilder: boolean;
+};
+/**
+ * @group Entity properties
+ */
+export type ResolvedGeopointProperty = Omit<GeopointProperty, "dataType"> & {
+    dataType: "geopoint";
+    resolved: true;
+    fromBuilder: boolean;
+};
+/**
+ * @group Entity properties
+ */
+export type ResolvedReferenceProperty = Omit<ReferenceProperty, "dataType"> & {
+    dataType: "reference";
+    resolved: true;
+    fromBuilder: boolean;
+};
+/**
+ * @group Entity properties
+ */
+export type ResolvedArrayProperty<T extends ArrayT[] = any[], ArrayT extends CMSType = CMSType> = Omit<ArrayProperty, "of" | "oneOf" | "dataType"> & {
+    dataType: "array";
+    resolved: true;
+    of?: ResolvedProperty<any> | ResolvedProperty<any>[];
+    oneOf?: {
+        properties: ResolvedProperties;
+        typeField?: string;
+        valueField?: string;
+    };
+    resolvedProperties: ResolvedProperty<any>[];
+    fromBuilder: boolean;
+};
+/**
+ * @group Entity properties
+ */
+export type ResolvedMapProperty<T extends Record<string, any> = any> = Omit<MapProperty, "properties" | "dataType" | "propertiesOrder"> & {
+    dataType: "map";
+    resolved: true;
+    properties?: ResolvedProperties<T>;
+    propertiesOrder?: Extract<keyof T, string>[];
+    fromBuilder: boolean;
+};

package/src/types/side_dialogs_controller.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Controller to open the side dialog
+ * @group Hooks and utilities
+ */
+export interface SideDialogsController {
+    /**
+     * Close the last panel
+     */
+    close: () => void;
+    /**
+     * List of side panels currently open
+     */
+    sidePanels: SideDialogPanelProps[];
+    /**
+     * Open one or multiple side panels
+     * @param props
+     */
+    open: (panelProps: SideDialogPanelProps | SideDialogPanelProps[]) => void;
+    /**
+     * Replace the last open panel with the given one
+     * @param props
+     */
+    replace: (panelProps: SideDialogPanelProps | SideDialogPanelProps[]) => void;
+}
+/**
+ * Props used to open a side dialog
+ * @group Hooks and utilities
+ */
+export interface SideDialogPanelProps {
+    /**
+     * A key that identifies this panel
+     */
+    key: string;
+    /**
+     * The component type that will be rendered
+     */
+    component: React.ReactNode;
+    /**
+     * Optional width of the panel
+     */
+    width?: string;
+    /**
+     * When open, change the URL to this path.
+     * Note that if you want to restore state from a URL you need to add the
+     * logic yourself by listening to URL updates, and probably call `open`.
+     */
+    urlPath?: string;
+    /**
+     * If the navigation stack is empty (you landed in the `urlPath` url), what
+     * url path to change to when the panel gets closed.
+     */
+    parentUrlPath?: string;
+    /**
+     * Callback when the panel is closed
+     */
+    onClose?: () => void;
+}

package/src/types/side_entity_controller.d.ts

@@ -0,0 +1,83 @@
+import { EntityCollection } from "./collections";
+import { ResolvedEntityCollection } from "./resolved_entities";
+import { Entity } from "./entities";
+/**
+ * Props used to open a side dialog
+ * @group Hooks and utilities
+ */
+export interface EntitySidePanelProps<M extends Record<string, any> = any> {
+    /**
+     * Absolute path of the entity
+     */
+    path: string;
+    /**
+     * ID of the entity, if not set, it means we are creating a new entity
+     */
+    entityId?: string;
+    /**
+     * Set this flag to true if you want to make a copy of an existing entity
+     */
+    copy?: boolean;
+    /**
+     * Open the entity with a selected sub-collection view. If the panel for this
+     * entity was already open, it is replaced.
+     */
+    selectedSubPath?: string;
+    /**
+     * Use this prop to override the width of the form view.
+     * e.g. "600px"
+     */
+    width?: number | string;
+    /**
+     * Collection representing the entities of this view.
+     * If you leave it blank it will be induced by your navigation
+     */
+    collection?: EntityCollection<M> | ResolvedEntityCollection<M>;
+    /**
+     * Should update the URL when opening the dialog.
+     * Consider that if the collection that you provide is not defined in the base
+     * config of your `FireCMS` component, you will not be able to recreate
+     * the state if copying the URL to a different window.
+     */
+    updateUrl?: boolean;
+    /**
+     * Callback when the entity is updated
+     * @param params
+     */
+    onUpdate?: (params: {
+        entity: Entity<any>;
+    }) => void;
+    /**
+     * Callback when the dialog is closed
+     */
+    onClose?: () => void;
+    /**
+     * Should this panel close when saving
+     */
+    closeOnSave?: boolean;
+}
+/**
+ * Controller to open the side dialog displaying entity forms
+ * @group Hooks and utilities
+ */
+export interface SideEntityController {
+    /**
+     * Close the last panel
+     */
+    close: () => void;
+    /**
+     * Open a new entity sideDialog. By default, the collection and configuration
+     * of the view is fetched from the collections you have specified in the
+     * navigation.
+     * At least you need to pass the path of the entity you would like
+     * to edit. You can set an entityId if you would like to edit and existing one
+     * (or a new one with that id).
+     * @param props
+     */
+    open: <M extends Record<string, any> = any>(props: EntitySidePanelProps<M>) => void;
+    /**
+     * Replace the last open entity panel with the given one.
+     * @param props
+     */
+    replace: <M extends Record<string, any> = any>(props: EntitySidePanelProps<M>) => void;
+}

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/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/util/arrays.d.ts

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

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/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/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/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/dates.d.ts

@@ -0,0 +1 @@
+export declare 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;

package/src/util/enums.d.ts

@@ -0,0 +1,7 @@
+import { EnumValueConfig, EnumValues } from "../types";
+import { ChipColorScheme } from "@firecms/ui";
+export declare function enumToObjectEntries(enumValues: EnumValues): EnumValueConfig[];
+export declare function getLabelOrConfigFrom(enumValues: EnumValueConfig[], key?: string | number): EnumValueConfig | undefined;
+export declare function getColorScheme(enumValues: EnumValueConfig[], key: string | number): ChipColorScheme | undefined;
+export declare function isEnumValueDisabled(labelOrConfig?: string | EnumValueConfig): boolean | undefined;
+export declare function buildEnumLabel(labelOrConfig?: string | EnumValueConfig): string | undefined;

package/src/util/flatten_object.d.ts

@@ -0,0 +1,3 @@
+export declare function flattenObject(obj: any, parentKey?: string): any;
+export type ArrayValuesCount = Record<string, number>;
+export declare function getArrayValuesCount(array: any[]): ArrayValuesCount;

package/src/util/hash.d.ts

@@ -0,0 +1 @@
+export declare function hashString(str: string): number;

package/src/util/icons.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { CMSView, EntityCollection } from "../types";
+export declare function getIcon(iconKey?: string, className?: string): React.ReactElement | undefined;
+export declare function getIconForView(collectionOrView: EntityCollection | CMSView, className?: string): React.ReactElement;

package/src/util/index.d.ts

@@ -0,0 +1,20 @@
+export * from "./collections";
+export * from "./entities";
+export * from "./strings";
+export * from "./dates";
+export * from "./enums";
+export * from "./objects";
+export * from "./paths";
+export * from "./regexp";
+export * from "./navigation_utils";
+export * from "./useDebounce";
+export * from "./property_utils";
+export * from "./resolutions";
+export * from "./permissions";
+export * from "./icons";
+export * from "./plurals";
+export * from "./references";
+export * from "./flatten_object";
+export * from "./make_properties_editable";
+export * from "./join_collections";
+export * from "./builders";

package/src/util/join_collections.d.ts

@@ -0,0 +1,9 @@
+import { EntityCollection, ModifyCollectionProps } from "../types";
+/**
+ *
+ */
+export declare function joinCollectionLists(targetCollections: EntityCollection[], sourceCollections: EntityCollection[] | undefined, parentPaths?: string[], modifyCollection?: (props: ModifyCollectionProps) => EntityCollection | void): EntityCollection[];
+/**
+ *
+ */
+export declare function mergeCollection(target: EntityCollection, source: EntityCollection, parentPaths?: string[], modifyCollection?: (props: ModifyCollectionProps) => EntityCollection | void): EntityCollection;

package/src/util/make_properties_editable.d.ts

@@ -0,0 +1,3 @@
+import { Properties, PropertiesOrBuilders } from "../types";
+export declare function makePropertiesEditable(properties: Properties): Properties<any>;
+export declare function makePropertiesNonEditable(properties: PropertiesOrBuilders): PropertiesOrBuilders;

package/src/util/navigation_from_path.d.ts

@@ -0,0 +1,24 @@
+import { EntityCollection, EntityCustomView } from "../types";
+export type NavigationViewInternal<M extends Record<string, any> = any> = NavigationViewEntityInternal<M> | NavigationViewCollectionInternal<M> | NavigationViewEntityCustomInternal<M>;
+export interface NavigationViewEntityInternal<M extends Record<string, any>> {
+    type: "entity";
+    entityId: string;
+    path: string;
+    parentCollection: EntityCollection<M>;
+}
+export interface NavigationViewCollectionInternal<M extends Record<string, any>> {
+    type: "collection";
+    path: string;
+    collection: EntityCollection<M>;
+}
+export interface NavigationViewEntityCustomInternal<M extends Record<string, any>> {
+    type: "custom_view";
+    path: string;
+    view: EntityCustomView<M>;
+}
+export declare function getNavigationEntriesFromPathInternal(props: {
+    path: string;
+    collections: EntityCollection[] | undefined;
+    currentFullPath?: string;
+    contextEntityViews?: EntityCustomView<any>[];
+}): NavigationViewInternal[];

package/src/util/navigation_utils.d.ts

@@ -0,0 +1,20 @@
+import { EntityCollection } from "../types";
+export declare function removeInitialAndTrailingSlashes(s: string): string;
+export declare function removeInitialSlash(s: string): string;
+export declare function removeTrailingSlash(s: string): string;
+export declare function addInitialSlash(s: string): string;
+export declare function getLastSegment(path: string): string;
+export declare function resolveCollectionPathIds(path: string, allCollections: EntityCollection[]): string;
+/**
+ * Find the corresponding view at any depth for a given path.
+ * Note that path or segments of the paths can be collection aliases.
+ * @param pathOrAlias
+ * @param collections
+ */
+export declare function getCollectionByPathOrId(pathOrAlias: string, collections: EntityCollection[]): EntityCollection | undefined;
+/**
+ * Get the subcollection combinations from a path:
+ * "sites/es/locales" => ["sites/es/locales", "sites"]
+ * @param subpaths
+ */
+export declare function getCollectionPathsCombinations(subpaths: string[]): string[];

package/src/util/objects.d.ts

@@ -0,0 +1,10 @@
+export declare const pick: <T>(obj: T, ...args: any[]) => T;
+export declare function isObject(item: any): any;
+export declare function mergeDeep<T extends object>(target: T, source: any): T;
+export declare function getValueInPath(o: object | undefined, path: string): any;
+export declare function removeInPath(o: object, path: string): object | undefined;
+export declare function removeFunctions(o: object | undefined): any;
+export declare function getHashValue<T>(v: T): any;
+export declare function removeUndefined(value: any, removeEmptyStrings?: boolean): any;
+export declare function isEmptyObject(obj: object): boolean;
+export declare function removePropsIfExisting(source: any, comparison: any): any;

package/src/util/parent_references_from_path.d.ts

@@ -0,0 +1,6 @@
+import { EntityCollection, EntityReference } from "../types";
+export declare function getParentReferencesFromPath(props: {
+    path: string;
+    collections: EntityCollection[] | undefined;
+    currentFullPath?: string;
+}): EntityReference[];

package/src/util/paths.d.ts

@@ -0,0 +1,14 @@
+export declare const COLLECTION_PATH_SEPARATOR = "::";
+/**
+ * Remove the entity ids from a given path
+ * `products/B44RG6APH/locales` => `products::locales`
+ * @param path
+ */
+export declare function stripCollectionPath(path: string): string;
+export declare function segmentsToStrippedPath(paths: string[]): string;
+/**
+ * Extract the collection path routes
+ * `products/B44RG6APH/locales` => [`products`, `locales`]
+ * @param path
+ */
+export declare function fullPathToCollectionSegments(path: string): string[];