@uniformdev/assets 19.141.1-alpha.5 → 19.142.1

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.
package/dist/index.d.mts CHANGED
@@ -588,6 +588,35 @@ interface external {
588
588
  * @enum {string}
589
589
  */
590
590
  syntax: "jptr";
591
+ /**
592
+ * @description The action to take if the dynamic token cannot be resolved
593
+ * - t: TOKEN: Removes the failed dynamic token value, leaving the rest of the property value, if any, intact [default]
594
+ * NOTE: if the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
595
+ * NOTE: if the _failureDefault_ property is also set, that default value will be used instead of removing the token.
596
+ * this only applies when the failureAction is 't' or undefined, the default is otherwise ignored.
597
+ * - p: PROPERTY: Removes the entire property value, including any other dynamic tokens or static values in the property
598
+ * - c: COMPONENT: Removes the whole parent component or block that contains the property.
599
+ * NOTE: If a 'component' failure occurs on the root component of a composition, or on an entry,
600
+ * it is treated as an 'a' failure because removing the root means we must remove all.
601
+ * - a: ALL: Fails the whole entry or composition. This will result in the item returning a 404 from APIs, and being removed from API list responses.
602
+ *
603
+ * @enum {string}
604
+ */
605
+ failureAction?: "t" | "p" | "c" | "a";
606
+ /**
607
+ * @description How to report when the dynamic token cannot be resolved
608
+ * - e: ERROR: Report an error message (this will prevent publishing)
609
+ * - w: WARNING: Report a warning message [default]
610
+ * - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
611
+ *
612
+ * @enum {string}
613
+ */
614
+ failureLogLevel?: "e" | "w" | "i";
615
+ /**
616
+ * @description The default value to use if the dynamic token cannot be resolved.
617
+ * This is only used if the failureAction is the default (undefined, or explicitly token).
618
+ */
619
+ failureDefault?: string;
591
620
  };
592
621
  /** @description Defines the shape of a component instance served by the composition API. */
593
622
  ComponentInstance: {
@@ -1322,7 +1351,7 @@ interface external {
1322
1351
  /** @description The name of the query string parameter */
1323
1352
  name: string;
1324
1353
  /** @description The default value of the query string if it is not provided by an incoming route path */
1325
- value: string;
1354
+ value?: string;
1326
1355
  /** @description Help text for authors who might be setting up a preview value for this query string */
1327
1356
  helpText?: string;
1328
1357
  };
package/dist/index.d.ts CHANGED
@@ -588,6 +588,35 @@ interface external {
588
588
  * @enum {string}
589
589
  */
590
590
  syntax: "jptr";
591
+ /**
592
+ * @description The action to take if the dynamic token cannot be resolved
593
+ * - t: TOKEN: Removes the failed dynamic token value, leaving the rest of the property value, if any, intact [default]
594
+ * NOTE: if the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
595
+ * NOTE: if the _failureDefault_ property is also set, that default value will be used instead of removing the token.
596
+ * this only applies when the failureAction is 't' or undefined, the default is otherwise ignored.
597
+ * - p: PROPERTY: Removes the entire property value, including any other dynamic tokens or static values in the property
598
+ * - c: COMPONENT: Removes the whole parent component or block that contains the property.
599
+ * NOTE: If a 'component' failure occurs on the root component of a composition, or on an entry,
600
+ * it is treated as an 'a' failure because removing the root means we must remove all.
601
+ * - a: ALL: Fails the whole entry or composition. This will result in the item returning a 404 from APIs, and being removed from API list responses.
602
+ *
603
+ * @enum {string}
604
+ */
605
+ failureAction?: "t" | "p" | "c" | "a";
606
+ /**
607
+ * @description How to report when the dynamic token cannot be resolved
608
+ * - e: ERROR: Report an error message (this will prevent publishing)
609
+ * - w: WARNING: Report a warning message [default]
610
+ * - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
611
+ *
612
+ * @enum {string}
613
+ */
614
+ failureLogLevel?: "e" | "w" | "i";
615
+ /**
616
+ * @description The default value to use if the dynamic token cannot be resolved.
617
+ * This is only used if the failureAction is the default (undefined, or explicitly token).
618
+ */
619
+ failureDefault?: string;
591
620
  };
592
621
  /** @description Defines the shape of a component instance served by the composition API. */
593
622
  ComponentInstance: {
@@ -1322,7 +1351,7 @@ interface external {
1322
1351
  /** @description The name of the query string parameter */
1323
1352
  name: string;
1324
1353
  /** @description The default value of the query string if it is not provided by an incoming route path */
1325
- value: string;
1354
+ value?: string;
1326
1355
  /** @description Help text for authors who might be setting up a preview value for this query string */
1327
1356
  helpText?: string;
1328
1357
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/assets",
3
- "version": "19.141.1-alpha.5+4c722bef9c",
3
+ "version": "19.142.1",
4
4
  "description": "Uniform Assets",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "main": "./dist/index.js",
@@ -36,7 +36,7 @@
36
36
  "access": "public"
37
37
  },
38
38
  "dependencies": {
39
- "@uniformdev/context": "19.141.1-alpha.5+4c722bef9c"
39
+ "@uniformdev/context": "19.142.1"
40
40
  },
41
- "gitHead": "4c722bef9cfbf90b8981cec47fadec37b02a3c12"
41
+ "gitHead": "e158ea370c3f68625a3ea743298ec9ae4d2fc391"
42
42
  }