@rathnasgala2/schemas 3.14.1 → 3.16.0

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

@@ -0,0 +1,54 @@
+// Generated from urn:gala:schema:analytics-config:2.0.0; sourceDesignRevision=a53052955ceb6c1aa10c886289dc832eedfe6de0a00004df07d353ac19c4403a.
+// Do not edit.
+
+export type AnalyticsConfigBcp47 = string;
+
+export type AnalyticsConfigCanonicalRoute = string;
+
+export type AnalyticsConfigDigest = string;
+
+export type AnalyticsConfigExtensionKey = string;
+
+export type AnalyticsConfigGitObjectId = string;
+
+export type AnalyticsConfigGlob = string;
+
+export type AnalyticsConfigIsoCountry = string;
+
+export type AnalyticsConfigPackageExact = string;
+
+export type AnalyticsConfigPackageRange = string;
+
+export type AnalyticsConfigPassiveVisualToken = never;
+
+export type AnalyticsConfigPlainLabel = string;
+
+export type AnalyticsConfigPlainText = string;
+
+export type AnalyticsConfigRepoRelativePath = string;
+
+export type AnalyticsConfigRfc3339 = string;
+
+export type AnalyticsConfigSemver = string;
+
+export type AnalyticsConfigSemverRange = string;
+
+export type AnalyticsConfigSlug = string;
+
+export type AnalyticsConfigStableId = string;
+
+export type AnalyticsConfigUrlHttps = string;
+
+export type AnalyticsConfigUrn = string;
+
+export type AnalyticsConfigDocument = Readonly<{
+  readonly consent: Readonly<{
+    readonly policy: 'opt-in';
+  }>;
+  readonly provider: Readonly<{
+    readonly kind: 'google-analytics-4';
+    readonly measurementId: string;
+  }>;
+  readonly schemaId: 'urn:gala:schema:analytics-config:2.0.0';
+  readonly schemaVersion: '2.0.0';
+}>;

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

@@ -1,6 +1,18 @@
 // Generated from urn:gala:schema:build-input:2.0.0; sourceDesignRevision=a53052955ceb6c1aa10c886289dc832eedfe6de0a00004df07d353ac19c4403a.
 // Do not edit.
 
+export type BuildInputAnalyticsConfig = Readonly<{
+  readonly consent: Readonly<{
+    readonly policy: 'opt-in';
+  }>;
+  readonly provider: Readonly<{
+    readonly kind: 'google-analytics-4';
+    readonly measurementId: string;
+  }>;
+  readonly schemaId: 'urn:gala:schema:analytics-config:2.0.0';
+  readonly schemaVersion: '2.0.0';
+}>;
+
 export type BuildInputAppearanceNormalized = Readonly<{
   readonly attribution?: BuildInputAttribution;
   readonly brandMark?: BuildInputResolvedFile;
@@ -216,6 +228,9 @@ export type BuildInputManifestRenderPolicyIdentity = Readonly<{
 }>;
 
 export type BuildInputModuleBuildSelection = Readonly<{
+  readonly analytics?: Readonly<{
+    readonly config: BuildInputAnalyticsConfig;
+  }>;
   readonly interactions?: Readonly<{
     readonly apiOrigin: BuildInputInteractionsServiceOrigin;
     readonly appOrigin: BuildInputInteractionsServiceOrigin;
@@ -278,6 +293,16 @@ export type BuildInputPlainLabel = string;
 
 export type BuildInputPlainText = string;
 
+export type BuildInputPoliciesNormalized = Readonly<{
+  readonly privacy: BuildInputPolicyPageNormalized;
+  readonly terms: BuildInputPolicyPageNormalized;
+}>;
+
+export type BuildInputPolicyPageNormalized = Readonly<{
+  readonly body: BuildInputRenderableBody;
+  readonly title: BuildInputPlainText;
+}>;
+
 export type BuildInputPublicationNormalized = Readonly<{
   readonly authorIds: ReadonlyArray<BuildInputStableId>;
   readonly canonicalBase: BuildInputUrlHttps;
@@ -431,6 +456,7 @@ export type BuildInputDocument = Readonly<{
   readonly navigation: BuildInputNavigationNormalized;
   readonly packages: BuildInputBuildPackages;
   readonly placements: [];
+  readonly policies?: BuildInputPoliciesNormalized;
   readonly publication: BuildInputPublicationNormalized;
   readonly repository: BuildInputRepositorySnapshot;
   readonly schemaId: 'urn:gala:schema:build-input:2.0.0';

package/generated/typescript/contracts/publication.d.ts

@@ -44,6 +44,16 @@ export type PublicationPlainLabel = string;
 
 export type PublicationPlainText = string;
 
+export type PublicationPolicyPage = Readonly<{
+  readonly body: PublicationRepoRelativePath;
+  readonly title: PublicationPlainText;
+}>;
+
+export type PublicationPublicationPolicies = Readonly<{
+  readonly privacy: PublicationPolicyPage;
+  readonly terms: PublicationPolicyPage;
+}>;
+
 export type PublicationPublicationProfile = Readonly<{
   readonly body: PublicationRepoRelativePath;
   readonly route: PublicationCanonicalRoute;
@@ -93,6 +103,7 @@ export type PublicationDocument = Readonly<{
   readonly footerCard?: PublicationFooterCard;
   readonly id: PublicationStableId;
   readonly newsletter?: PublicationNewsletter;
+  readonly policies?: PublicationPublicationPolicies;
   readonly profile?: PublicationPublicationProfile;
   readonly schemaId: 'urn:gala:schema:publication:2.0.0';
   readonly schemaVersion: '2.0.0';

package/generated/typescript/index.d.ts

@@ -18,6 +18,10 @@ export type { AdapterCapabilityDocument } from './contracts/adapter-capability.j
 export declare function isAdapterCapabilityDocument(
   value: unknown,
 ): value is import('./contracts/adapter-capability.js').AdapterCapabilityDocument;
+export type { AnalyticsConfigDocument } from './contracts/analytics-config.js';
+export declare function isAnalyticsConfigDocument(
+  value: unknown,
+): value is import('./contracts/analytics-config.js').AnalyticsConfigDocument;
 export type { AppearanceDocument } from './contracts/appearance.js';
 export declare function isAppearanceDocument(
   value: unknown,

package/generated/typescript/index.js

@@ -5,6 +5,7 @@ import { validateGalaDocument } from '../../src/index.js';
 
 const SCHEMA_IDS = [
   'urn:gala:schema:adapter-capability:2.0.0',
+  'urn:gala:schema:analytics-config:2.0.0',
   'urn:gala:schema:appearance:2.0.0',
   'urn:gala:schema:artifact-manifest:2.0.0',
   'urn:gala:schema:author:2.0.0',
@@ -67,6 +68,19 @@ export function isAdapterCapabilityDocument(value) {
   ).valid;
 }
 
+/**
+ * Test whether a value is a valid AnalyticsConfigDocument.
+ *
+ * @param {unknown} value candidate document
+ * @returns {boolean} validation result
+ */
+export function isAnalyticsConfigDocument(value) {
+  return validateGeneratedDocument(
+    'urn:gala:schema:analytics-config:2.0.0',
+    value,
+  ).valid;
+}
+
 /**
  * Test whether a value is a valid AppearanceDocument.
  *

package/openapi/http-catalog.json

@@ -1,7 +1,7 @@
 {
   "schemaVersion": "2.0.0",
   "sourceDesignRevision": "a53052955ceb6c1aa10c886289dc832eedfe6de0a00004df07d353ac19c4403a",
-  "openApiDigest": "sha256:52ee6b8f76bd4677837614ccba3b895f38667c23a7d36e0d2201a45fd71ae7e9",
+  "openApiDigest": "sha256:9f788998e00babc25ff76f7ef7e7e5f491b4532ead1e95c8aef5c1f81ad81eda",
   "operations": [
     {
       "operationId": "getInternalHealth",
@@ -759,6 +759,32 @@
       "apiKeyScope": null,
       "sourceFragment": "organizations"
     },
+    {
+      "operationId": "getOrganizationsByOrganizationIdPublicationsByPublicationIdAnalyticsSettings",
+      "method": "GET",
+      "path": "/v2/organizations/{organizationId}/publications/{publicationId}/analytics-settings",
+      "purpose": "read this publication's analytics settings at the main branch head",
+      "capabilityKey": "publication.view",
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "apiKeyScope": "read",
+      "sourceFragment": "interaction-settings"
+    },
+    {
+      "operationId": "putOrganizationsByOrganizationIdPublicationsByPublicationIdAnalyticsSettings",
+      "method": "PUT",
+      "path": "/v2/organizations/{organizationId}/publications/{publicationId}/analytics-settings",
+      "purpose": "save this publication's analytics settings as a repository change",
+      "capabilityKey": "publication.settings.manage",
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "apiKeyScope": "content:write",
+      "sourceFragment": "interaction-settings"
+    },
     {
       "operationId": "getOrganizationsByOrganizationIdPublicationsByPublicationIdAppearance",
       "method": "GET",
@@ -1219,6 +1245,32 @@
       "apiKeyScope": null,
       "sourceFragment": "moderation"
     },
+    {
+      "operationId": "getOrganizationsByOrganizationIdPublicationsByPublicationIdPolicySettings",
+      "method": "GET",
+      "path": "/v2/organizations/{organizationId}/publications/{publicationId}/policy-settings",
+      "purpose": "read this publication's Terms and Privacy text at the main branch head",
+      "capabilityKey": "publication.view",
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "apiKeyScope": "read",
+      "sourceFragment": "interaction-settings"
+    },
+    {
+      "operationId": "putOrganizationsByOrganizationIdPublicationsByPublicationIdPolicySettings",
+      "method": "PUT",
+      "path": "/v2/organizations/{organizationId}/publications/{publicationId}/policy-settings",
+      "purpose": "save this publication's Terms and Privacy text as a repository change",
+      "capabilityKey": "publication.settings.manage",
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "apiKeyScope": "content:write",
+      "sourceFragment": "interaction-settings"
+    },
     {
       "operationId": "getOrganizationsByOrganizationIdPublicationsByPublicationIdPrismGenerations",
       "method": "GET",
@@ -2634,5 +2686,5 @@
       "sourceFragment": "workloads"
     }
   ],
-  "digest": "sha256:b9653b8233ca2573186efe14bc3d5d4dd4709ef0814c1e3f843d8c45a8e9d32f"
+  "digest": "sha256:0e62172fd7069e162b78a730cf4c677f21f3492d549a91c16687a0ccce3cec42"
 }