@arcgis/toolkit 5.0.0-next.30 → 5.0.0-next.31

package/dist/log/index.cjs

@@ -19,7 +19,7 @@ const getContextString = (context) => {
 };
 const log = (level, context, message, options) => {
   const contextString = getContextString(context);
-  if (options.once) {
+  if (options?.once) {
     const key = `${level}${contextString}${message}`;
     if (loggedMessages.has(key)) {
       return;
@@ -29,19 +29,20 @@ const log = (level, context, message, options) => {
   esriConfig?.log.interceptors?.forEach((interceptor) => interceptor(level, contextString, message));
   console[level](`[${contextString}]`, message);
 };
-const logIfMissingProperty = (level, context, property, options) => {
-  const value = context[property];
-  if (Array.isArray(value) && !value.length) {
-    return log(level, context, `The \`${property.toString()}\` property must have at least one element.`, options);
-  } else if (value == null) {
-    return log(level, context, `The \`${property.toString()}\` property is required but missing.`, options);
-  }
-};
+const composeMissingPropertyMessage = (property) => (
+  //#endregion composeMissingPropertyMessage
+  `The property \`${property.toString()}\` is required but missing.`
+);
+const composeEmptyPropertyMessage = (property) => (
+  //#endregion composeEmptyPropertyMessage
+  `The property \`${property.toString()}\` is empty but must have at least one element.`
+);
 const logDeprecatedProperty = (context, oldName, newName, options) => (
   //#endregion logDeprecatedProperty
   log("warn", context, `\`${oldName.toString()}\` is deprecated. Use \`${newName.toString()}\` instead.`, options)
 );
+exports.composeEmptyPropertyMessage = composeEmptyPropertyMessage;
+exports.composeMissingPropertyMessage = composeMissingPropertyMessage;
 exports.log = log;
 exports.logDeprecatedProperty = logDeprecatedProperty;
-exports.logIfMissingProperty = logIfMissingProperty;
 exports.setEsriConfig = setEsriConfig;

package/dist/log/index.d.cts

@@ -1,4 +1,4 @@
-type LogLevel = "error" | "info" | "warn";
+export type LogLevel = "error" | "info" | "warn";
 type CustomElementLike = {
     el: {
         localName: string;
@@ -9,9 +9,8 @@ type CustomElementLike = {
 type AccessorLike = {
     declaredClass: string;
 };
-type ErrorContext = AccessorLike | CustomElementLike | string;
-export type Logger = (level: LogLevel, context: ErrorContext, message: unknown, options: LoggerOptions) => void;
-type LoggerOptions = {
+export type LogContext = AccessorLike | CustomElementLike | string;
+type LogOptions = {
     /** Whether the message should only be logged once */
     once?: boolean;
 };
@@ -55,17 +54,33 @@ export declare const setEsriConfig: (config: EsriConfig) => void;
  * );
  * ```
  */
-export declare const log: Logger;
+export declare const log: (level: LogLevel, context: LogContext, message: unknown, options?: LogOptions) => void;
+type LogContextOrObject = Exclude<LogContext, string> | object;
+type InferPropertyType<T extends LogContextOrObject> = [object] extends [T] ? string : keyof T;
 /**
- * Logs a message if a required property of the given context object is nullish (or an empty array).
- * @param property The missing property to check for
- * @param params Parameters to forward to the logger
+ * Returns a string that can be used in log messages for missing required properties.
+ * @param property The name of the required property
  * @example
  * ```ts
- * logIfMissingProperty<typeof this>("warn", this, "items", { once: true });
+ * // returns "The property `x` is required but missing."
+ * composeMissingPropertyMessage<YourClass>("x");
+ * // you don't need to provide a generic type argument if you don't have one
+ * composeMissingPropertyMessage("object.sub.property");
  * ```
  */
-export declare const logIfMissingProperty: <T extends ErrorContext>(level: LogLevel, context: T, property: keyof T, options: LoggerOptions) => ReturnType<typeof log>;
+export declare const composeMissingPropertyMessage: <T extends LogContextOrObject = object>(property: InferPropertyType<T>) => string;
+/**
+ * Returns a string that can be used in log messages for empty required arrays.
+ * @param property The name of the required property
+ * @example
+ * ```ts
+ * // returns "The property `x` is empty but must have at least one element."
+ * composeEmptyPropertyMessage<YourClass>("x");
+ * // you don't need to provide a generic type argument if you don't have one
+ * composeEmptyPropertyMessage("object.sub.property");
+ * ```
+ */
+export declare const composeEmptyPropertyMessage: <T extends LogContextOrObject = object>(property: InferPropertyType<T>) => string;
 /**
  * Logs a warning message for deprecated object properties.
  * @example
@@ -75,5 +90,5 @@ export declare const logIfMissingProperty: <T extends ErrorContext>(level: LogLe
  * });
  * ```
  */
-export declare const logDeprecatedProperty: <T extends ErrorContext>(context: T, oldName: keyof T, newName: keyof T, options: LoggerOptions) => ReturnType<typeof log>;
+export declare const logDeprecatedProperty: <T extends LogContext>(context: T, oldName: keyof T, newName: keyof T, options?: LogOptions) => ReturnType<typeof log>;
 export {};

package/dist/log/index.d.ts

@@ -1,4 +1,4 @@
-type LogLevel = "error" | "info" | "warn";
+export type LogLevel = "error" | "info" | "warn";
 type CustomElementLike = {
     el: {
         localName: string;
@@ -9,9 +9,8 @@ type CustomElementLike = {
 type AccessorLike = {
     declaredClass: string;
 };
-type ErrorContext = AccessorLike | CustomElementLike | string;
-export type Logger = (level: LogLevel, context: ErrorContext, message: unknown, options: LoggerOptions) => void;
-type LoggerOptions = {
+export type LogContext = AccessorLike | CustomElementLike | string;
+type LogOptions = {
     /** Whether the message should only be logged once */
     once?: boolean;
 };
@@ -55,17 +54,33 @@ export declare const setEsriConfig: (config: EsriConfig) => void;
  * );
  * ```
  */
-export declare const log: Logger;
+export declare const log: (level: LogLevel, context: LogContext, message: unknown, options?: LogOptions) => void;
+type LogContextOrObject = Exclude<LogContext, string> | object;
+type InferPropertyType<T extends LogContextOrObject> = [object] extends [T] ? string : keyof T;
 /**
- * Logs a message if a required property of the given context object is nullish (or an empty array).
- * @param property The missing property to check for
- * @param params Parameters to forward to the logger
+ * Returns a string that can be used in log messages for missing required properties.
+ * @param property The name of the required property
  * @example
  * ```ts
- * logIfMissingProperty<typeof this>("warn", this, "items", { once: true });
+ * // returns "The property `x` is required but missing."
+ * composeMissingPropertyMessage<YourClass>("x");
+ * // you don't need to provide a generic type argument if you don't have one
+ * composeMissingPropertyMessage("object.sub.property");
  * ```
  */
-export declare const logIfMissingProperty: <T extends ErrorContext>(level: LogLevel, context: T, property: keyof T, options: LoggerOptions) => ReturnType<typeof log>;
+export declare const composeMissingPropertyMessage: <T extends LogContextOrObject = object>(property: InferPropertyType<T>) => string;
+/**
+ * Returns a string that can be used in log messages for empty required arrays.
+ * @param property The name of the required property
+ * @example
+ * ```ts
+ * // returns "The property `x` is empty but must have at least one element."
+ * composeEmptyPropertyMessage<YourClass>("x");
+ * // you don't need to provide a generic type argument if you don't have one
+ * composeEmptyPropertyMessage("object.sub.property");
+ * ```
+ */
+export declare const composeEmptyPropertyMessage: <T extends LogContextOrObject = object>(property: InferPropertyType<T>) => string;
 /**
  * Logs a warning message for deprecated object properties.
  * @example
@@ -75,5 +90,5 @@ export declare const logIfMissingProperty: <T extends ErrorContext>(level: LogLe
  * });
  * ```
  */
-export declare const logDeprecatedProperty: <T extends ErrorContext>(context: T, oldName: keyof T, newName: keyof T, options: LoggerOptions) => ReturnType<typeof log>;
+export declare const logDeprecatedProperty: <T extends LogContext>(context: T, oldName: keyof T, newName: keyof T, options?: LogOptions) => ReturnType<typeof log>;
 export {};

package/dist/log/index.js

@@ -17,7 +17,7 @@ const getContextString = (context) => {
 };
 const log = (level, context, message, options) => {
   const contextString = getContextString(context);
-  if (options.once) {
+  if (options?.once) {
     const key = `${level}${contextString}${message}`;
     if (loggedMessages.has(key)) {
       return;
@@ -27,21 +27,22 @@ const log = (level, context, message, options) => {
   esriConfig?.log.interceptors?.forEach((interceptor) => interceptor(level, contextString, message));
   console[level](`[${contextString}]`, message);
 };
-const logIfMissingProperty = (level, context, property, options) => {
-  const value = context[property];
-  if (Array.isArray(value) && !value.length) {
-    return log(level, context, `The \`${property.toString()}\` property must have at least one element.`, options);
-  } else if (value == null) {
-    return log(level, context, `The \`${property.toString()}\` property is required but missing.`, options);
-  }
-};
+const composeMissingPropertyMessage = (property) => (
+  //#endregion composeMissingPropertyMessage
+  `The property \`${property.toString()}\` is required but missing.`
+);
+const composeEmptyPropertyMessage = (property) => (
+  //#endregion composeEmptyPropertyMessage
+  `The property \`${property.toString()}\` is empty but must have at least one element.`
+);
 const logDeprecatedProperty = (context, oldName, newName, options) => (
   //#endregion logDeprecatedProperty
   log("warn", context, `\`${oldName.toString()}\` is deprecated. Use \`${newName.toString()}\` instead.`, options)
 );
 export {
+  composeEmptyPropertyMessage,
+  composeMissingPropertyMessage,
   log,
   logDeprecatedProperty,
-  logIfMissingProperty,
   setEsriConfig
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/toolkit",
-  "version": "5.0.0-next.30",
+  "version": "5.0.0-next.31",
   "description": "Collection of common internal patterns and utilities for ArcGIS Maps SDK for JavaScript components.",
   "homepage": "https://developers.arcgis.com/javascript/latest/",
   "sideEffects": false,