@rathnasgala2/schemas 3.0.0 → 3.1.0

package/generated/typescript/contracts/artifact-manifest.d.ts

@@ -250,7 +250,7 @@ export type ArtifactManifestManifestReproducibleBuildRecord = Readonly<{
 
 export type ArtifactManifestManifestRoute = Readonly<{
   readonly byteLength: ArtifactManifestNonNegativeInt64;
-  readonly interactionBearing: false;
+  readonly interactionBearing: boolean;
   readonly mediaType:
     | 'text/html; charset=utf-8'
     | 'text/css; charset=utf-8'

package/generated/typescript/contracts/build-input.d.ts

@@ -153,6 +153,26 @@ export type BuildInputGithubPositiveDecimal = string;
 
 export type BuildInputGlob = string;
 
+export type BuildInputInteractionsConfig = Readonly<{
+  readonly comments: Readonly<{
+    readonly allowReplies: boolean;
+    readonly enabled: boolean;
+    readonly maxDepth: number;
+  }>;
+  readonly publicCounts: Readonly<{
+    readonly comments: boolean;
+    readonly reactions: boolean;
+  }>;
+  readonly reactions: Readonly<{
+    readonly definitions: ReadonlyArray<BuildInputReactionDefinition>;
+    readonly enabled: boolean;
+  }>;
+  readonly schemaId: 'urn:gala:schema:interactions-config:2.0.0';
+  readonly schemaVersion: '2.0.0';
+}>;
+
+export type BuildInputInteractionsServiceOrigin = string;
+
 export type BuildInputIsoCountry = string;
 
 export type BuildInputLocalizedAuthor = Readonly<{
@@ -167,7 +187,13 @@ export type BuildInputManifestRenderPolicyIdentity = Readonly<{
   readonly version: BuildInputSemver;
 }>;
 
-export type BuildInputModuleBuildSelection = Readonly<Record<string, never>>;
+export type BuildInputModuleBuildSelection = Readonly<{
+  readonly interactions?: Readonly<{
+    readonly apiOrigin: BuildInputInteractionsServiceOrigin;
+    readonly appOrigin: BuildInputInteractionsServiceOrigin;
+    readonly config: BuildInputInteractionsConfig;
+  }>;
+}>;
 
 export type BuildInputNavigationItem = Readonly<{
   readonly children: ReadonlyArray<BuildInputNavigationLeaf>;
@@ -257,6 +283,37 @@ export type BuildInputPublicationNormalized = Readonly<{
   readonly title: BuildInputPlainText;
 }>;
 
+export type BuildInputReactionDefinition = Readonly<{
+  readonly enabled: boolean;
+  readonly key: BuildInputReactionKey;
+  readonly label: BuildInputPlainLabel & string;
+  readonly order: number;
+  readonly visual: BuildInputReactionVisual;
+}>;
+
+export type BuildInputReactionKey = string;
+
+export type BuildInputReactionVisual = Readonly<{
+  readonly kind: 'emoji';
+  readonly token:
+    | '👍'
+    | '❤️'
+    | '💡'
+    | '🎉'
+    | '😂'
+    | '🤯'
+    | '🙏'
+    | '🔥'
+    | '👏'
+    | '😮'
+    | '😢'
+    | '🤔'
+    | '✨'
+    | '🚀'
+    | '💯'
+    | '👀';
+}>;
+
 export type BuildInputRenderableBody = Readonly<{
   readonly body: string;
   readonly bodyDigest: BuildInputDigest;

package/generated/typescript/contracts/build-provenance.d.ts

@@ -250,7 +250,7 @@ export type BuildProvenanceManifestReproducibleBuildRecord = Readonly<{
 
 export type BuildProvenanceManifestRoute = Readonly<{
   readonly byteLength: BuildProvenanceNonNegativeInt64;
-  readonly interactionBearing: false;
+  readonly interactionBearing: boolean;
   readonly mediaType:
     | 'text/html; charset=utf-8'
     | 'text/css; charset=utf-8'

package/generated/typescript/contracts/interactions-config.d.ts

@@ -0,0 +1,91 @@
+// Generated from urn:gala:schema:interactions-config:2.0.0; sourceDesignRevision=a53052955ceb6c1aa10c886289dc832eedfe6de0a00004df07d353ac19c4403a.
+// Do not edit.
+
+export type InteractionsConfigBcp47 = string;
+
+export type InteractionsConfigCanonicalRoute = string;
+
+export type InteractionsConfigDigest = string;
+
+export type InteractionsConfigExtensionKey = string;
+
+export type InteractionsConfigGitObjectId = string;
+
+export type InteractionsConfigGlob = string;
+
+export type InteractionsConfigIsoCountry = string;
+
+export type InteractionsConfigPackageExact = string;
+
+export type InteractionsConfigPackageRange = string;
+
+export type InteractionsConfigPassiveVisualToken = never;
+
+export type InteractionsConfigPlainLabel = string;
+
+export type InteractionsConfigPlainText = string;
+
+export type InteractionsConfigReactionDefinition = Readonly<{
+  readonly enabled: boolean;
+  readonly key: InteractionsConfigReactionKey;
+  readonly label: InteractionsConfigPlainLabel & string;
+  readonly order: number;
+  readonly visual: InteractionsConfigReactionVisual;
+}>;
+
+export type InteractionsConfigReactionKey = string;
+
+export type InteractionsConfigReactionVisual = Readonly<{
+  readonly kind: 'emoji';
+  readonly token:
+    | '👍'
+    | '❤️'
+    | '💡'
+    | '🎉'
+    | '😂'
+    | '🤯'
+    | '🙏'
+    | '🔥'
+    | '👏'
+    | '😮'
+    | '😢'
+    | '🤔'
+    | '✨'
+    | '🚀'
+    | '💯'
+    | '👀';
+}>;
+
+export type InteractionsConfigRepoRelativePath = string;
+
+export type InteractionsConfigRfc3339 = string;
+
+export type InteractionsConfigSemver = string;
+
+export type InteractionsConfigSemverRange = string;
+
+export type InteractionsConfigSlug = string;
+
+export type InteractionsConfigStableId = string;
+
+export type InteractionsConfigUrlHttps = string;
+
+export type InteractionsConfigUrn = string;
+
+export type InteractionsConfigDocument = Readonly<{
+  readonly comments: Readonly<{
+    readonly allowReplies: boolean;
+    readonly enabled: boolean;
+    readonly maxDepth: number;
+  }>;
+  readonly publicCounts: Readonly<{
+    readonly comments: boolean;
+    readonly reactions: boolean;
+  }>;
+  readonly reactions: Readonly<{
+    readonly definitions: ReadonlyArray<InteractionsConfigReactionDefinition>;
+    readonly enabled: boolean;
+  }>;
+  readonly schemaId: 'urn:gala:schema:interactions-config:2.0.0';
+  readonly schemaVersion: '2.0.0';
+}>;

package/generated/typescript/index.d.ts

@@ -58,6 +58,10 @@ export type { EventEnvelopeDocument } from './contracts/event-envelope.js';
 export declare function isEventEnvelopeDocument(
   value: unknown,
 ): value is import('./contracts/event-envelope.js').EventEnvelopeDocument;
+export type { InteractionsConfigDocument } from './contracts/interactions-config.js';
+export declare function isInteractionsConfigDocument(
+  value: unknown,
+): value is import('./contracts/interactions-config.js').InteractionsConfigDocument;
 export type { LockDocument } from './contracts/lock.js';
 export declare function isLockDocument(
   value: unknown,

package/generated/typescript/index.js

@@ -15,6 +15,7 @@ const SCHEMA_IDS = [
   'urn:gala:schema:deployment-observation:2.0.0',
   'urn:gala:schema:deployment-receipt:2.0.0',
   'urn:gala:schema:event-envelope:2.0.0',
+  'urn:gala:schema:interactions-config:2.0.0',
   'urn:gala:schema:lock:2.0.0',
   'urn:gala:schema:navigation:2.0.0',
   'urn:gala:schema:problem:2.0.0',
@@ -189,6 +190,19 @@ export function isEventEnvelopeDocument(value) {
   ).valid;
 }
 
+/**
+ * Test whether a value is a valid InteractionsConfigDocument.
+ *
+ * @param {unknown} value candidate document
+ * @returns {boolean} validation result
+ */
+export function isInteractionsConfigDocument(value) {
+  return validateGeneratedDocument(
+    'urn:gala:schema:interactions-config:2.0.0',
+    value,
+  ).valid;
+}
+
 /**
  * Test whether a value is a valid LockDocument.
  *

package/openapi/http-catalog.json

@@ -1,7 +1,7 @@
 {
   "schemaVersion": "2.0.0",
   "sourceDesignRevision": "a53052955ceb6c1aa10c886289dc832eedfe6de0a00004df07d353ac19c4403a",
-  "openApiDigest": "sha256:f3d0acf21a5fe89857d94dfa3067bbb59486a3e3a7f263cdd261695238303290",
+  "openApiDigest": "sha256:b926672f6094bd397d63ae05f96eff46a47109e12aeca1761bdb3ee7c3957e5e",
   "operations": [
     {
       "operationId": "getInternalHealth",
@@ -634,6 +634,66 @@
       "actionGrant": "none",
       "sourceFragment": "organizations"
     },
+    {
+      "operationId": "getOrganizationsByOrganizationIdPublicationsByPublicationIdInteractionAggregates",
+      "method": "GET",
+      "path": "/v2/organizations/{organizationId}/publications/{publicationId}/interaction-aggregates",
+      "purpose": "read exact reaction and comment totals per article",
+      "capabilityKey": "publication.view",
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "sourceFragment": "moderation"
+    },
+    {
+      "operationId": "getOrganizationsByOrganizationIdPublicationsByPublicationIdInteractionSettings",
+      "method": "GET",
+      "path": "/v2/organizations/{organizationId}/publications/{publicationId}/interaction-settings",
+      "purpose": "read this publication's reader interaction settings at the main branch head",
+      "capabilityKey": "publication.view",
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "sourceFragment": "interaction-settings"
+    },
+    {
+      "operationId": "putOrganizationsByOrganizationIdPublicationsByPublicationIdInteractionSettings",
+      "method": "PUT",
+      "path": "/v2/organizations/{organizationId}/publications/{publicationId}/interaction-settings",
+      "purpose": "save this publication's reader interaction settings as a repository change",
+      "capabilityKey": "publication.source.write",
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "sourceFragment": "interaction-settings"
+    },
+    {
+      "operationId": "postOrganizationsByOrganizationIdPublicationsByPublicationIdModerationCommentsByCommentIdDecide",
+      "method": "POST",
+      "path": "/v2/organizations/{organizationId}/publications/{publicationId}/moderation/comments/{commentId}:decide",
+      "purpose": "record a moderation decision on one comment",
+      "capabilityKey": "publication.moderate",
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "sourceFragment": "moderation"
+    },
+    {
+      "operationId": "getOrganizationsByOrganizationIdPublicationsByPublicationIdModerationQueue",
+      "method": "GET",
+      "path": "/v2/organizations/{organizationId}/publications/{publicationId}/moderation/queue",
+      "purpose": "list comments awaiting or carrying a moderation outcome",
+      "capabilityKey": "publication.moderate",
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "sourceFragment": "moderation"
+    },
     {
       "operationId": "postOrganizationsByOrganizationIdPublicationsByPublicationIdPublishes",
       "method": "POST",
@@ -884,6 +944,150 @@
       "actionGrant": "none",
       "sourceFragment": "organizations"
     },
+    {
+      "operationId": "deletePublicCommentsByCommentId",
+      "method": "DELETE",
+      "path": "/v2/public/comments/{commentId}",
+      "purpose": "delete the reader's own comment",
+      "capabilityKey": null,
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "sourceFragment": "public-interactions"
+    },
+    {
+      "operationId": "postPublicCommentsByCommentIdReports",
+      "method": "POST",
+      "path": "/v2/public/comments/{commentId}/reports",
+      "purpose": "report a comment as the signed-in reader",
+      "capabilityKey": null,
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "sourceFragment": "public-interactions"
+    },
+    {
+      "operationId": "postPublicCommentsByCommentIdRevisions",
+      "method": "POST",
+      "path": "/v2/public/comments/{commentId}/revisions",
+      "purpose": "edit the reader's own comment inside the edit window",
+      "capabilityKey": null,
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "sourceFragment": "public-interactions"
+    },
+    {
+      "operationId": "getPublicPublicationsByPublicationId",
+      "method": "GET",
+      "path": "/v2/public/publications/{publicationId}",
+      "purpose": "read the public identity of a live publication",
+      "capabilityKey": null,
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "sourceFragment": "public-interactions"
+    },
+    {
+      "operationId": "getPublicPublicationsByPublicationIdContentsByContentIdComments",
+      "method": "GET",
+      "path": "/v2/public/publications/{publicationId}/contents/{contentId}/comments",
+      "purpose": "list the visible comments of one article",
+      "capabilityKey": null,
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "sourceFragment": "public-interactions"
+    },
+    {
+      "operationId": "postPublicPublicationsByPublicationIdContentsByContentIdComments",
+      "method": "POST",
+      "path": "/v2/public/publications/{publicationId}/contents/{contentId}/comments",
+      "purpose": "post a comment or a reply as the signed-in reader",
+      "capabilityKey": null,
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "sourceFragment": "public-interactions"
+    },
+    {
+      "operationId": "getPublicPublicationsByPublicationIdContentsByContentIdInteractions",
+      "method": "GET",
+      "path": "/v2/public/publications/{publicationId}/contents/{contentId}/interactions",
+      "purpose": "read the effective reader interactions and counts of one article",
+      "capabilityKey": null,
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "sourceFragment": "public-interactions"
+    },
+    {
+      "operationId": "deletePublicPublicationsByPublicationIdContentsByContentIdReactionsByReactionKey",
+      "method": "DELETE",
+      "path": "/v2/public/publications/{publicationId}/contents/{contentId}/reactions/{reactionKey}",
+      "purpose": "clear the signed-in reader's reaction on one article",
+      "capabilityKey": null,
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "sourceFragment": "public-interactions"
+    },
+    {
+      "operationId": "putPublicPublicationsByPublicationIdContentsByContentIdReactionsByReactionKey",
+      "method": "PUT",
+      "path": "/v2/public/publications/{publicationId}/contents/{contentId}/reactions/{reactionKey}",
+      "purpose": "set the signed-in reader's reaction on one article",
+      "capabilityKey": null,
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "sourceFragment": "public-interactions"
+    },
+    {
+      "operationId": "postReaderAuthorizations",
+      "method": "POST",
+      "path": "/v2/reader/authorizations",
+      "purpose": "authorize a visiting reader for one publication and return the redirect",
+      "capabilityKey": null,
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "sourceFragment": "reader"
+    },
+    {
+      "operationId": "postReaderTokens",
+      "method": "POST",
+      "path": "/v2/reader/tokens",
+      "purpose": "exchange a one-time authorization code for a publication-scoped reader token",
+      "capabilityKey": null,
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "sourceFragment": "reader"
+    },
+    {
+      "operationId": "deleteReaderTokensCurrent",
+      "method": "DELETE",
+      "path": "/v2/reader/tokens/current",
+      "purpose": "revoke the reader token that made the request",
+      "capabilityKey": null,
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "sourceFragment": "reader"
+    },
     {
       "operationId": "getSelfAuthenticators",
       "method": "GET",
@@ -1016,6 +1220,30 @@
       "actionGrant": "none",
       "sourceFragment": "self"
     },
+    {
+      "operationId": "getSelfReaderConnections",
+      "method": "GET",
+      "path": "/v2/self/reader-connections",
+      "purpose": "list the publications this person is connected to as a reader",
+      "capabilityKey": null,
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "sourceFragment": "self"
+    },
+    {
+      "operationId": "deleteSelfReaderConnectionsByPublicationId",
+      "method": "DELETE",
+      "path": "/v2/self/reader-connections/{publicationId}",
+      "purpose": "revoke every reader token this person holds for one publication",
+      "capabilityKey": null,
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "sourceFragment": "self"
+    },
     {
       "operationId": "postSelfRecoveryCodeSets",
       "method": "POST",
@@ -1113,5 +1341,5 @@
       "sourceFragment": "workloads"
     }
   ],
-  "digest": "sha256:60cc9daaec10eda1f7fdfa827b76a337be99ab1b8498b0205dfc0a10a683b87c"
+  "digest": "sha256:ea81649bfded3f08fa1b7cbe4de25d76c2becfc5899daa2e807b7d8a4870fa25"
 }