@esri/hub-common 24.5.0 → 24.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +1 @@
1
- {"version":3,"file":"layout-system-types.js","sourceRoot":"","sources":["../../../src/layouts/layout-system-types.ts"],"names":[],"mappings":"AAaA,8DAA8D;AAC9D,MAAM,CAAC,MAAM,WAAW,GAA+B;IACrD,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,GAAG;IACP,EAAE,EAAE,GAAG;IACP,EAAE,EAAE,GAAG;IACP,EAAE,EAAE,IAAI;IACR,GAAG,EAAE,IAAI;CACV,CAAC;AA2dF;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,uBAAuB;IACvB,mBAAmB;IACnB,sBAAsB;IACtB,gBAAgB;IAChB,cAAc;IACd,gBAAgB;IAChB,kBAAkB;IAClB,yBAAyB;IACzB,kBAAkB;IAClB,uBAAuB;IACvB,iBAAiB;IACjB,qBAAqB;IACrB,4BAA4B;IAC5B,oBAAoB;IACpB,qBAAqB;IACrB,gCAAgC;IAChC,qCAAqC;IACrC,+BAA+B;IAC/B,gCAAgC;IAChC,qCAAqC;IACrC,wBAAwB;IACxB,KAAK;CACG,CAAC;AAIX;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,gCAAgC;IAChC,uBAAuB;IACvB,2BAA2B;IAC3B,8BAA8B;IAC9B,4BAA4B;IAC5B,8BAA8B;CACtB,CAAC"}
1
+ {"version":3,"file":"layout-system-types.js","sourceRoot":"","sources":["../../../src/layouts/layout-system-types.ts"],"names":[],"mappings":"AAaA,8DAA8D;AAC9D,MAAM,CAAC,MAAM,WAAW,GAA+B;IACrD,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,GAAG;IACP,EAAE,EAAE,GAAG;IACP,EAAE,EAAE,GAAG;IACP,EAAE,EAAE,IAAI;IACR,GAAG,EAAE,IAAI;CACV,CAAC;AAqeF;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,uBAAuB;IACvB,mBAAmB;IACnB,sBAAsB;IACtB,gBAAgB;IAChB,cAAc;IACd,gBAAgB;IAChB,kBAAkB;IAClB,yBAAyB;IACzB,kBAAkB;IAClB,uBAAuB;IACvB,iBAAiB;IACjB,qBAAqB;IACrB,4BAA4B;IAC5B,oBAAoB;IACpB,qBAAqB;IACrB,gCAAgC;IAChC,qCAAqC;IACrC,+BAA+B;IAC/B,gCAAgC;IAChC,qCAAqC;IACrC,wBAAwB;IACxB,KAAK;CACG,CAAC;AAIX;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,gCAAgC;IAChC,uBAAuB;IACvB,2BAA2B;IAC3B,8BAA8B;IAC9B,4BAA4B;IAC5B,8BAA8B;CACtB,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"layout-system-types.js","sourceRoot":"","sources":["../../../src/layouts/layout-system-types.ts"],"names":[],"mappings":";;;AAaA,8DAA8D;AACjD,QAAA,WAAW,GAA+B;IACrD,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,GAAG;IACP,EAAE,EAAE,GAAG;IACP,EAAE,EAAE,GAAG;IACP,EAAE,EAAE,IAAI;IACR,GAAG,EAAE,IAAI;CACV,CAAC;AA2dF;;;;GAIG;AACU,QAAA,cAAc,GAAG;IAC5B,uBAAuB;IACvB,mBAAmB;IACnB,sBAAsB;IACtB,gBAAgB;IAChB,cAAc;IACd,gBAAgB;IAChB,kBAAkB;IAClB,yBAAyB;IACzB,kBAAkB;IAClB,uBAAuB;IACvB,iBAAiB;IACjB,qBAAqB;IACrB,4BAA4B;IAC5B,oBAAoB;IACpB,qBAAqB;IACrB,gCAAgC;IAChC,qCAAqC;IACrC,+BAA+B;IAC/B,gCAAgC;IAChC,qCAAqC;IACrC,wBAAwB;IACxB,KAAK;CACG,CAAC;AAIX;;;GAGG;AACU,QAAA,gBAAgB,GAAG;IAC9B,gCAAgC;IAChC,uBAAuB;IACvB,2BAA2B;IAC3B,8BAA8B;IAC9B,4BAA4B;IAC5B,8BAA8B;CACtB,CAAC"}
1
+ {"version":3,"file":"layout-system-types.js","sourceRoot":"","sources":["../../../src/layouts/layout-system-types.ts"],"names":[],"mappings":";;;AAaA,8DAA8D;AACjD,QAAA,WAAW,GAA+B;IACrD,EAAE,EAAE,CAAC;IACL,EAAE,EAAE,GAAG;IACP,EAAE,EAAE,GAAG;IACP,EAAE,EAAE,GAAG;IACP,EAAE,EAAE,IAAI;IACR,GAAG,EAAE,IAAI;CACV,CAAC;AAqeF;;;;GAIG;AACU,QAAA,cAAc,GAAG;IAC5B,uBAAuB;IACvB,mBAAmB;IACnB,sBAAsB;IACtB,gBAAgB;IAChB,cAAc;IACd,gBAAgB;IAChB,kBAAkB;IAClB,yBAAyB;IACzB,kBAAkB;IAClB,uBAAuB;IACvB,iBAAiB;IACjB,qBAAqB;IACrB,4BAA4B;IAC5B,oBAAoB;IACpB,qBAAqB;IACrB,gCAAgC;IAChC,qCAAqC;IACrC,+BAA+B;IAC/B,gCAAgC;IAChC,qCAAqC;IACrC,wBAAwB;IACxB,KAAK;CACG,CAAC;AAIX;;;GAGG;AACU,QAAA,gBAAgB,GAAG;IAC9B,gCAAgC;IAChC,uBAAuB;IACvB,2BAA2B;IAC3B,8BAA8B;IAC9B,4BAA4B;IAC5B,8BAA8B;CACtB,CAAC"}
@@ -255,9 +255,11 @@ export interface IHistoryEntry {
255
255
  * the layout system. All layout node components
256
256
  * should implement this interface to ensure
257
257
  * consistency.
258
+ *
259
+ * Note: this is temporarily an empty interface that
260
+ * can be expanded in the future as needed.
258
261
  */
259
262
  export interface IConfigurableLayoutNode {
260
- layoutNodeConfig?: ILayoutNodeConfig;
261
263
  }
262
264
  /**
263
265
  * Type representing an HTML element that extends
@@ -277,6 +279,10 @@ export interface ILayoutNodeConfig {
277
279
  name: string;
278
280
  /** Tag of the layout node. */
279
281
  tag: LayoutNodeTag;
282
+ /** Whether this node is disabled in the add menu */
283
+ disableAdd?: boolean;
284
+ /** Whether to hide this node in the add menu */
285
+ hideAdd?: boolean;
280
286
  /** Whether the node is editable. */
281
287
  disableEdit?: boolean;
282
288
  /** Whether the node is repositionable. */
@@ -287,6 +293,8 @@ export interface ILayoutNodeConfig {
287
293
  disableAdjustVisibility?: boolean;
288
294
  /** Default values for the node's configuration. */
289
295
  defaults: Record<string, unknown>;
296
+ /** Optional icon to represent the node in the UI. */
297
+ icon?: string;
290
298
  /**
291
299
  * Various translation strings to display or use for a11y
292
300
  * purposes in the node's editing UI
@@ -366,8 +374,10 @@ export type LayoutNodeEditorConfig = (LayoutNodeEditorConfigBase & {
366
374
  uiSchema: IUiSchema;
367
375
  });
368
376
  /**
369
- * Interfrace representing the available options for
370
- * processing a layout.
377
+ * Interface representing contextual information
378
+ * used to process various parts of the layout
379
+ * system (e.g. processing the layout itself,
380
+ * generating addable layout nodes, etc.)
371
381
  */
372
382
  export interface IProcessLayoutOptions {
373
383
  entity?: HubEntity;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@esri/hub-common",
3
- "version": "24.5.0",
3
+ "version": "24.6.0",
4
4
  "description": "Common TypeScript types and utility functions for @esri/hub.js.",
5
5
  "main": "dist/node/index.js",
6
6
  "module": "dist/esm/index.js",