@firecms/schema_inference 3.0.0-canary.7 → 3.0.0-canary.70

package/LICENSE

@@ -1,21 +1,113 @@
-MIT License
-
-Copyright (c) 2023 FireCMS
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+Business Source License 1.1
+
+Parameters
+
+Licensor:             Firecms S.L.
+Licensed Work:        Firecms CMS packages:
+                      cli
+                      collection_editor
+                      collection_editor_firebase
+                      data_enhancement
+                      data_import_export
+                      editor
+                      firecms_cloud
+                      schema_inference
+                      user_management
+
+                      The Licensed Work is (c) 2024 Firecms S.L
+Additional Use Grant: You may make use of the Licensed Work, provided that
+                      you may not use the Licensed Work for a CMS Data Enhancement
+                      Service.
+
+                      A “CMS package” is a commercial offering that
+                      allows third parties (other than your employees and
+                      contractors) to access the functionality of the
+                      Licensed Work by using software to extend the base features of
+                      content management system controlled by such third parties.
+
+Change Date:         Four years from the date the Licensed Work is published.
+
+Change License:      MIT
+
+For information about alternative licensing arrangements for the Software,
+please visit: https://firecms.co
+
+Notice
+
+The Business Source License (this document, or the “License”) is not an Open
+Source license. However, the Licensed Work will eventually be made available
+under an Open Source License, as stated in this License.
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
+“Business Source License” is a trademark of MariaDB Corporation Ab.
+
+-----------------------------------------------------------------------------
+
+Business Source License 1.1
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited
+production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under
+the terms of the Change License, and the rights granted in the paragraph
+above terminate.
+
+If your use of the Licensed Work does not comply with the requirements
+currently in effect as described in this License, you must purchase a
+commercial license from the Licensor, its affiliated entities, or authorized
+resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works
+of the Licensed Work, are subject to this License. This License applies
+separately for each version of the Licensed Work and the Change Date may vary
+for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy
+of the Licensed Work. If you receive the Licensed Work in original or
+modified form from a third party, the terms and conditions set forth in this
+License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other
+versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of
+Licensor or its affiliates (provided that you may use a trademark or logo of
+Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+TITLE.
+
+MariaDB hereby grants you permission to use this License’s text to license
+your works, and to refer to it using the trademark “Business Source License”,
+as long as you comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+
+In consideration of the right to use this License’s text and the “Business
+Source License” name and trademark, Licensor covenants to MariaDB, and to all
+other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version,
+   or a license that is compatible with GPL Version 2.0 or a later version,
+   where “compatible” means that software provided under the Change License can
+   be included in a program with software provided under GPL Version 2.0 or a
+   later version. Licensor may specify additional Change Licenses without
+   limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not
+   impose any additional restriction on the right granted in this License, as
+   the Additional Use Grant; or (b) insert the text “None”.
+
+3. To specify a Change Date.
+
+4. Not to modify this License in any other way.

package/dist/collection_builder.d.ts

@@ -1,5 +1,6 @@
-import { DataType, Properties, Property } from "@firecms/core";
+import { DataType, Properties, PropertiesOrBuilders, Property } from "@firecms/core";
 export type InferenceTypeBuilder = (value: any) => DataType;
 export declare function buildEntityPropertiesFromData(data: object[], getType: InferenceTypeBuilder): Promise<Properties>;
 export declare function buildPropertyFromData(data: any[], property: Property, getType: InferenceTypeBuilder): Property;
-export declare function buildPropertiesOrder(properties: Properties<any>): string[];
+export declare function buildPropertiesOrder(properties: PropertiesOrBuilders, propertiesOrder?: string[], priorityKeys?: string[]): string[];
+export declare function inferTypeFromValue(value: any): DataType;

package/dist/index.es.js

@@ -1,28 +1,28 @@
-import { unslugify as b, resolveEnumValues as T, mergeDeep as j } from "@firecms/core";
-import { DocumentReference as P } from "firebase/firestore";
-function y(r) {
+import { unslugify as O, resolveEnumValues as T, mergeDeep as j } from "@firecms/core";
+import { DocumentReference as C } from "@firebase/firestore";
+function b(r) {
   if (!r)
     return;
-  function e(i) {
-    return typeof i == "string" ? i : i instanceof P ? i.path : void 0;
+  function e(n) {
+    return typeof n == "string" ? n : n instanceof C ? n.path : void 0;
   }
-  const s = r.values.map((i) => e(i)).filter((i) => !!i).find((i) => i.includes("/"));
+  const s = r.values.map((n) => e(n)).filter((n) => !!n).find((n) => n.includes("/"));
   if (!s)
     return;
-  const n = s.substr(0, s.lastIndexOf("/"));
-  return r.values.filter((i) => {
-    const a = e(i);
-    return a ? a.startsWith(n) : !1;
-  }).length > r.values.length / 3 * 2 ? n : void 0;
+  const i = s.substr(0, s.lastIndexOf("/"));
+  return r.values.filter((n) => {
+    const a = e(n);
+    return a ? a.startsWith(i) : !1;
+  }).length > r.values.length / 3 * 2 ? i : void 0;
 }
 function d(r) {
   if (!Array.isArray(r))
     return [];
-  const e = r.map((t) => typeof t == "string" ? { id: t, label: b(t) } : null).filter(Boolean);
+  const e = r.map((t) => typeof t == "string" ? { id: t, label: O(t) } : null).filter(Boolean);
   return e.sort((t, s) => t.label.localeCompare(s.label)), e;
 }
-const I = [".jpg", ".png", ".webp", ".gif"], S = [".mp3", ".ogg", ".opus", ".aac"], M = [".avi", ".mp4"], x = /^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/;
-function C({
+const P = [".jpg", ".jpeg", ".png", ".webp", ".gif", ".avif"], S = [".mp3", ".ogg", ".opus", ".aac"], I = [".avi", ".mp4"], M = /^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/;
+function w({
   totalDocsCount: r,
   valuesResult: e
 }) {
@@ -30,20 +30,20 @@ function C({
     dataType: "string"
   };
   if (e) {
-    const s = e.values.length, n = Array.from(e.valuesCount.keys()).length, o = {}, i = e.values.filter((f) => typeof f == "string" && f.toString().startsWith("http")).length > r / 3 * 2;
-    i && (o.url = !0);
-    const a = e.values.filter((f) => typeof f == "string" && x.test(f)).length > r / 3 * 2;
+    const s = e.values.length, i = Array.from(e.valuesCount.keys()).length, o = {}, n = e.values.filter((f) => typeof f == "string" && f.toString().startsWith("http")).length > r / 3 * 2;
+    n && (o.url = !0);
+    const a = e.values.filter((f) => typeof f == "string" && M.test(f)).length > r / 3 * 2;
     a && (o.email = !0);
     const c = e.values.filter((f) => typeof f == "string" && f.length === 28 && !f.includes(" ")).length > r / 3 * 2;
-    if (c && (o.readOnly = !0), !a && !i && !c && !i && n < s / 3) {
+    if (c && (o.readOnly = !0), !a && !n && !c && !n && i < s / 3) {
       const f = d(Array.from(e.valuesCount.keys()));
       Object.keys(f).length > 1 && (o.enumValues = f);
     }
-    if (!a && !i && !c && !i && !o.enumValues) {
-      const f = F(e, r);
+    if (!a && !n && !c && !n && !o.enumValues) {
+      const f = z(e, r);
       f && (o.storage = {
         acceptedFiles: [f],
-        storagePath: y(e) ?? "/"
+        storagePath: b(e) ?? "/"
       });
     }
     Object.keys(o).length > 0 && (t = {
@@ -54,11 +54,11 @@ function C({
   }
   return t;
 }
-function F(r, e) {
-  const t = r.values.filter((i) => typeof i == "string" && I.some((a) => i.toString().endsWith(a))).length > e / 3 * 2, s = r.values.filter((i) => typeof i == "string" && S.some((a) => i.toString().endsWith(a))).length > e / 3 * 2, n = r.values.filter((i) => typeof i == "string" && M.some((a) => i.toString().endsWith(a))).length > e / 3 * 2;
-  return t ? "image/*" : s ? "audio/*" : n ? "video/*" : !1;
+function z(r, e) {
+  const t = r.values.filter((n) => typeof n == "string" && P.some((a) => n.toString().endsWith(a))).length > e / 3 * 2, s = r.values.filter((n) => typeof n == "string" && S.some((a) => n.toString().endsWith(a))).length > e / 3 * 2, i = r.values.filter((n) => typeof n == "string" && I.some((a) => n.toString().endsWith(a))).length > e / 3 * 2;
+  return t ? "image/*" : s ? "audio/*" : i ? "video/*" : !1;
 }
-function V({
+function F({
   totalDocsCount: r,
   valuesResult: e
 }) {
@@ -76,169 +76,209 @@ function _({
 }) {
   return {
     dataType: "reference",
-    path: y(e) ?? "!!!FIX_ME!!!",
+    path: b(e) ?? "!!!FIX_ME!!!",
     editable: !0
   };
 }
 async function k(r, e) {
   const t = {}, s = {};
-  return r && r.forEach((n) => {
-    n && Object.entries(n).forEach(([o, i]) => {
-      E(t, o, i, e), p(s, o, i, e);
+  return r && r.forEach((i) => {
+    i && Object.entries(i).forEach(([o, n]) => {
+      u(t, o, n, e), m(s, o, n, e);
     });
-  }), O(r.length, t, s);
+  }), A(r.length, t, s);
 }
-function w(r, e, t) {
-  const s = {}, n = {};
+function L(r, e, t) {
+  const s = {}, i = {};
   r && r.forEach((a) => {
-    l(e.dataType, s, a, t), p(n, "inferred_prop", a, t);
+    p(e.dataType, s, a, t), m(i, "inferred_prop", a, t);
   });
   const o = "enumValues" in e ? T(e.enumValues) : void 0;
   if (o) {
-    const a = d(Array.from(n.inferred_prop.valuesCount.keys()));
+    const a = d(Array.from(i.inferred_prop.valuesCount.keys()));
     return {
       ...e,
       enumValues: [...a, ...o]
     };
   }
-  const i = g("inferred_prop", r.length, e.dataType, s, n.inferred_prop);
-  return j(i, e);
+  const n = y(
+    "inferred_prop",
+    r.length,
+    e.dataType,
+    s,
+    i.inferred_prop
+  );
+  return j(n, e);
 }
-function U(r) {
-  function e(s) {
-    const n = s.toLowerCase();
-    return n === "title" || n === "name" ? 3 : n.includes("title") || n.includes("name") ? 2 : n.includes("image") || n.includes("picture") ? 1 : 0;
+function U(r, e, t) {
+  const s = (t ?? []).map((n) => n.toLowerCase());
+  function i(n) {
+    const a = n.toLowerCase();
+    return s.includes(a) ? 4 : a === "title" || a === "name" ? 3 : a.includes("title") || a.includes("name") ? 2 : a.includes("image") || a.includes("picture") ? 1 : 0;
   }
-  const t = Object.keys(r);
-  return t.sort(), t.sort((s, n) => e(n) - e(s)), t;
+  const o = e ?? Object.keys(r);
+  return o.sort(), o.sort((n, a) => i(a) - i(n)), o;
 }
-function l(r, e, t, s) {
+function p(r, e, t, s) {
   if (r === "map") {
     if (t) {
-      let n = e[r];
-      n || (n = {}, e[r] = n), Object.entries(t).forEach(([o, i]) => {
-        E(n, o, i, s);
+      let i = e[r];
+      i || (i = {}, e[r] = i), Object.entries(t).forEach(([o, n]) => {
+        u(i, o, n, s);
       });
     }
   } else if (r === "array") {
-    let n = e[r];
-    if (n || (n = {}, e[r] = n), t && Array.isArray(t) && t.length > 0) {
-      const o = z(t, s);
-      n[o] ? n[o]++ : n[o] = 1;
+    let i = e[r];
+    if (i || (i = {}, e[r] = i), t && Array.isArray(t) && t.length > 0) {
+      const o = x(t, s);
+      if (o === "map") {
+        let n = i[o];
+        n || (n = {}), t.forEach((a) => {
+          Object.entries(a).forEach(
+            ([c, f]) => u(n, c, f, s)
+          );
+        }), i[o] = n;
+      } else
+        i[o] ? i[o]++ : i[o] = 1;
     }
   } else
     e[r] ? e[r]++ : e[r] = 1;
 }
-function E(r, e, t, s) {
-  let n = r[e];
-  if (n || (n = {}, r[e] = n), t != null) {
+function u(r, e, t, s) {
+  let i = r[e];
+  if (i || (i = {}, r[e] = i), t != null) {
     const o = s(t);
-    l(o, n, t, s);
+    p(o, i, t, s);
   }
 }
-function p(r, e, t, s) {
-  const n = s(t);
+function m(r, e, t, s) {
+  const i = s(t);
   let o = r[e];
   if (o || (o = {
     values: [],
     valuesCount: /* @__PURE__ */ new Map()
-  }, r[e] = o), n === "map") {
-    let i = o.map;
-    i || (i = {}, o.map = i), t && Object.entries(t).forEach(([a, c]) => p(i, a, c, s));
+  }, r[e] = o), i === "map") {
+    let n = o.map;
+    n || (n = {}, o.map = n), t && Object.entries(t).forEach(
+      ([a, c]) => m(n, a, c, s)
+    );
   } else
-    n === "array" ? Array.isArray(t) && t.forEach((i) => {
-      o.values.push(i), o.valuesCount.set(i, (o.valuesCount.get(i) ?? 0) + 1);
+    i === "array" ? Array.isArray(t) && t.forEach((n) => {
+      o.values.push(n), o.valuesCount.set(n, (o.valuesCount.get(n) ?? 0) + 1);
     }) : t && (o.values.push(t), o.valuesCount.set(t, (o.valuesCount.get(t) ?? 0) + 1));
 }
-function m(r) {
+function h(r) {
   let e = 0;
   return Object.entries(r).forEach(([t, s]) => {
-    let n = 0;
-    t === "map" ? n = A(s) : t === "array" ? n = m(s) : n = s, n > e && (e = n);
+    let i = 0;
+    t === "map" ? i = E(s) : t === "array" ? i = h(s) : i = s, i > e && (e = i);
   }), e;
 }
-function A(r) {
-  return Object.entries(r).map(([e, t]) => m(t)).reduce((e, t) => Math.max(e, t), 0);
+function E(r) {
+  return Object.entries(r).map(([e, t]) => h(t)).reduce((e, t) => Math.max(e, t), 0);
 }
-function h(r) {
+function g(r) {
   let e = -1, t = "string";
-  return Object.entries(r).forEach(([s, n]) => {
+  return Object.entries(r).forEach(([s, i]) => {
     let o;
-    s === "map" ? o = A(n) : s === "array" ? o = m(n) : o = n, o > e && (e = o, t = s);
+    s === "map" ? o = E(i) : s === "array" ? o = h(i) : o = i, o > e && (e = o, t = s);
   }), t;
 }
-function g(r, e, t, s, n) {
+function y(r, e, t, s, i) {
   let o;
-  r && (o = b(r));
-  let i;
+  r && (o = Z(r.toLowerCase()));
+  let n;
   if (t === "map") {
-    W(s) && (i = {
+    V(s) && (n = {
       dataType: "map",
       name: o,
       keyValue: !0,
       properties: {}
     });
-    const c = O(e, s.map, n ? n.mapValues : void 0);
-    i = {
+    const c = A(
+      e,
+      s.map,
+      i ? i.mapValues : void 0
+    );
+    n = {
       dataType: "map",
       name: o,
       properties: c
     };
   } else if (t === "array") {
-    const a = s.array, c = h(a), f = g(r, e, c, a, n);
-    i = {
+    const a = s.array, c = g(a), f = y(
+      r,
+      e,
+      c,
+      a,
+      i
+    );
+    n = {
       dataType: "array",
       name: o,
       of: f
     };
   }
-  if (!i) {
+  if (!n) {
     const a = {
       name: r,
       totalDocsCount: e,
-      valuesResult: n
+      valuesResult: i
     };
-    t === "string" ? i = C(a) : t === "reference" ? i = _(a) : i = {
+    t === "string" ? n = w(a) : t === "reference" ? n = _(a) : n = {
       dataType: t
-    }, o && (i.name = o);
-    const c = V(a);
-    c && (i.validation = c);
+    }, o && (n.name = o);
+    const c = F(a);
+    c && (n.validation = c);
   }
   return {
-    ...i,
+    ...n,
     editable: !0
   };
 }
-function O(r, e, t) {
+function A(r, e, t) {
   const s = {};
-  return Object.entries(e).forEach(([n, o]) => {
-    const i = h(o);
-    s[n] = g(n, r, i, o, t ? t[n] : void 0);
+  return Object.entries(e).forEach(([i, o]) => {
+    const n = g(o);
+    s[i] = y(
+      i,
+      r,
+      n,
+      o,
+      t ? t[i] : void 0
+    );
   }), s;
 }
-function u(r) {
+function l(r) {
   let e = 0;
   return Object.entries(r).forEach(([t, s]) => {
-    typeof s == "object" ? e = Math.max(e, u(s)) : e = Math.max(e, s);
+    typeof s == "object" ? e = Math.max(e, l(s)) : e = Math.max(e, s);
   }), e;
 }
-function z(r, e) {
+function x(r, e) {
   let t = {};
   return r.forEach((s) => {
-    l(e(s), t, s, e);
-  }), h(t);
+    p(e(s), t, s, e);
+  }), g(t);
 }
-function W(r) {
-  const e = u(r);
+function V(r) {
+  const e = l(r);
   let t = 0;
-  return Object.entries(r.map ?? {}).forEach(([s, n]) => {
-    u(n) < e / 3 && t++;
+  return Object.entries(r.map ?? {}).forEach(([s, i]) => {
+    l(i) < e / 3 && t++;
   }), t / Object.entries(r.map ?? {}).length > 0.5;
 }
+function Z(r) {
+  return r.replace(/[_\-]+/g, " ").replace(/([a-z])([A-Z])/g, "$1 $2").toLowerCase().split(" ").map((i) => i.charAt(0).toUpperCase() + i.slice(1)).join(" ");
+}
+function X(r) {
+  return typeof r == "string" ? "string" : typeof r == "number" ? "number" : typeof r == "boolean" ? "boolean" : Array.isArray(r) ? "array" : typeof r == "object" ? "map" : "string";
+}
 export {
   k as buildEntityPropertiesFromData,
   U as buildPropertiesOrder,
-  w as buildPropertyFromData,
-  d as extractEnumFromValues
+  L as buildPropertyFromData,
+  d as extractEnumFromValues,
+  X as inferTypeFromValue
 };
 //# sourceMappingURL=index.es.js.map