@zhin.js/console-contract 1.3.0 → 1.3.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/lib/page.d.ts CHANGED
@@ -320,6 +320,10 @@ export interface DeclarativePageSpec<TData = Record<string, unknown>> {
320
320
  readonly pluginId?: string;
321
321
  readonly title: DeclarativeI18nText;
322
322
  readonly description?: DeclarativeI18nText;
323
+ /**
324
+ * @deprecated ADR 0063 P2: the renderer no longer draws a letter tile in the page header; this
325
+ * field is ignored (the Console warns once when it is set) and will be removed in a later minor.
326
+ */
323
327
  readonly mark?: DeclarativeRenderable;
324
328
  /** Status RPC method name; defaults to `'status'`. */
325
329
  readonly statusMethod?: string;
@@ -446,7 +450,11 @@ export interface CommentReviewBlueprintSpec<E extends CommentReviewEndpointBase<
446
450
  readonly zh: string;
447
451
  readonly en: string;
448
452
  };
449
- readonly mark: string;
453
+ /**
454
+ * @deprecated ADR 0063 P2: ignored (no letter tile in the page header any more); not copied into
455
+ * the blueprint. Will be removed in a later minor.
456
+ */
457
+ readonly mark?: string;
450
458
  readonly resource: {
451
459
  readonly zh: string;
452
460
  readonly en: string;
package/lib/page.js CHANGED
@@ -533,7 +533,6 @@ export function defineCommentReviewPage(reviewSpec) {
533
533
  const blueprint = buildBlueprintFromSpec({
534
534
  pluginId: reviewSpec.adapter,
535
535
  title: { zh: zhTitle, 'zh-CN': zhTitle, en: enTitle },
536
- mark: reviewSpec.mark,
537
536
  statusMethod: 'status',
538
537
  pollMs: reviewSpec.pollMs ?? 10_000,
539
538
  ...(reviewSpec.dictionary ? { dictionary: reviewSpec.dictionary } : {}),
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zhin.js/console-contract",
3
- "version": "1.3.0",
3
+ "version": "1.3.1",
4
4
  "description": "Zero-dependency Page, Layout, route and navigation contracts for Zhin.js plugins",
5
5
  "type": "module",
6
6
  "main": "./lib/index.js",
package/src/page.ts CHANGED
@@ -762,6 +762,10 @@ export interface DeclarativePageSpec<TData = Record<string, unknown>> {
762
762
  readonly pluginId?: string;
763
763
  readonly title: DeclarativeI18nText;
764
764
  readonly description?: DeclarativeI18nText;
765
+ /**
766
+ * @deprecated ADR 0063 P2: the renderer no longer draws a letter tile in the page header; this
767
+ * field is ignored (the Console warns once when it is set) and will be removed in a later minor.
768
+ */
765
769
  readonly mark?: DeclarativeRenderable;
766
770
  /** Status RPC method name; defaults to `'status'`. */
767
771
  readonly statusMethod?: string;
@@ -903,7 +907,11 @@ export interface CommentReviewBlueprintSpec<
903
907
  > {
904
908
  readonly adapter: string;
905
909
  readonly platform: { readonly zh: string; readonly en: string };
906
- readonly mark: string;
910
+ /**
911
+ * @deprecated ADR 0063 P2: ignored (no letter tile in the page header any more); not copied into
912
+ * the blueprint. Will be removed in a later minor.
913
+ */
914
+ readonly mark?: string;
907
915
  readonly resource: { readonly zh: string; readonly en: string };
908
916
  readonly dictionary?: Readonly<Record<string, string>>;
909
917
  readonly openLabel?: string;
@@ -1160,7 +1168,6 @@ export function defineCommentReviewPage<
1160
1168
  const blueprint = buildBlueprintFromSpec<{ readonly endpoints?: readonly E[]; readonly updatedAt?: number }>({
1161
1169
  pluginId: reviewSpec.adapter,
1162
1170
  title: { zh: zhTitle, 'zh-CN': zhTitle, en: enTitle },
1163
- mark: reviewSpec.mark,
1164
1171
  statusMethod: 'status',
1165
1172
  pollMs: reviewSpec.pollMs ?? 10_000,
1166
1173
  ...(reviewSpec.dictionary ? { dictionary: reviewSpec.dictionary } : {}),