@pantheon-systems/css-client 0.18.2 → 0.19.0

package/dist/content.js

@@ -1,5 +1,6 @@
 import { P1ApiError } from './errors.js';
 import { resolveBaseUrl } from './constants.js';
+import { requirePathParams } from './utils.js';
 function trimTrailingSlashes(value) {
     let end = value.length;
     while (end > 0 && value[end - 1] === '/')
@@ -24,6 +25,7 @@ export class P1ContentClient {
         this.branchId = config.branchId;
     }
     async getPage(documentPath) {
+        requirePathParams({ siteId: this.siteId }, 'content.getPage');
         const cleanPath = documentPath === '/' ? '' : trimLeadingSlashes(documentPath);
         const pathSegment = cleanPath ? `/${cleanPath}` : '';
         let url = `${this.baseUrl}/api/sites/${this.siteId}/content${pathSegment}`;
@@ -43,6 +45,7 @@ export class P1ContentClient {
         return response.json();
     }
     async getRedirect(path) {
+        requirePathParams({ siteId: this.siteId }, 'content.getRedirect');
         const cleanPath = path === '/' ? '' : trimLeadingSlashes(path);
         const pathSegment = cleanPath ? `/${cleanPath}` : '';
         const url = `${this.baseUrl}/api/sites/${this.siteId}/content-redirects${pathSegment}`;
@@ -59,6 +62,7 @@ export class P1ContentClient {
         return response.json();
     }
     async getPagePaths() {
+        requirePathParams({ siteId: this.siteId }, 'content.getPagePaths');
         let url = `${this.baseUrl}/api/sites/${this.siteId}/content-pages`;
         if (this.branchId) {
             url += `?branch=${this.branchId}`;

package/dist/endpoints/documents.js

@@ -26,6 +26,9 @@ export class DocumentsEndpoint {
         if (options?.pathPrefix !== undefined) {
             params.set('pathPrefix', options.pathPrefix);
         }
+        if (options?.include && options.include.length > 0) {
+            params.set('include', options.include.join(','));
+        }
         const query = params.toString();
         const path = query
             ? `/api/sites/${siteId}/branches/${branchId}/documents?${query}`

package/dist/index.d.ts

@@ -6,7 +6,7 @@
 export { P1Client } from './client.js';
 export type { P1ClientConfig } from './client.js';
 export { PRODUCTION_BASE_URL } from './constants.js';
-export type { Site, Branch, BranchStatus, Document, DocumentVersion, DocumentVersionSource, Checkpoint, CheckpointType, CheckpointStatus, CheckpointDocument, WorkflowSettings, PuckData, PuckComponentData, PuckRootData, Principal, PaginationOptions, CreateBranchParams, CreateDocumentParams, CreateDocumentVersionParams, CreateCheckpointParams, PublishDocumentResult, ListDocumentsOptions, ActorState, ActorRole, ActorPresence, DocumentPresenceSummary, BranchPresenceSummary, BranchPresence, SitePresence, AgentPresenceLocation, AgentGlobalPresence, AgentStatus, AgentSettings, RegisteredAgent, CreateAgentParams, UpdateAgentParams, ListAgentsOptions, AgentTrigger, AgentEditDenialReason, AgentEditContext, AgentEditPermission, AgentEditSession, AgentEditCompleteResult, AgentEditAbortResult, AgentStopResult, UpdateFocusRegionsResponse, PublishResult, ConflictResolutionStrategy, MergeRequestStatus, DocumentConflictType, DocumentConflict, ConflictDetails, MergeabilityResult, DocumentDiff, MergePreview, MergeExecuteParams, MergeExecuteResult, MergeRequest, CreateMergeRequestParams, UpdateMergeRequestParams, ListMergeRequestsOptions, ExecuteMergeRequestOptions, Template, TemplateSummary, TemplateMetadata, TemplateContentItem, TemplateRootProps, CreateTemplateParams, UpdateTemplateParams, MigrationJob, MigrationConflict, MigrationPreview, MigrationPreviewDocument, TriggerMigrationParams, Datasource, QuerySortField, Query, QueryResultItem, QueryResultsMeta, QueryResults, QueryResultsParams, LocalePolicy, SiteLocales, SiteSettings, SiteSettingsResult, TranslationMode, LocalizationRelation, CreateTranslationParams, CreateTranslationResult, TranslationVariant, ListTranslationsResult, PropAuthority, AuthorityOverridesMap, AuthorityOverridesResult, ChangeClassification, ChangeSummaryEntry, ChangeSummary, UpstreamResolutions, UpstreamResolutionTarget, SiteMemberRole, AgentSiteRole, SiteMemberUser, SiteMemberAgent, SiteMembers, MergeJob, MergeJobStatus, } from './types/index.js';
+export type { Site, Branch, BranchStatus, Document, DocumentRouteSummary, DocumentVersion, DocumentVersionSource, Checkpoint, CheckpointType, CheckpointStatus, CheckpointDocument, WorkflowSettings, PuckData, PuckComponentData, PuckRootData, Principal, PaginationOptions, CreateBranchParams, CreateDocumentParams, CreateDocumentVersionParams, CreateCheckpointParams, PublishDocumentResult, ListDocumentsOptions, ActorState, ActorRole, ActorPresence, DocumentPresenceSummary, BranchPresenceSummary, BranchPresence, SitePresence, AgentPresenceLocation, AgentGlobalPresence, AgentStatus, AgentSettings, RegisteredAgent, CreateAgentParams, UpdateAgentParams, ListAgentsOptions, AgentTrigger, AgentEditDenialReason, AgentEditContext, AgentEditPermission, AgentEditSession, AgentEditCompleteResult, AgentEditAbortResult, AgentStopResult, UpdateFocusRegionsResponse, PublishResult, ConflictResolutionStrategy, MergeRequestStatus, DocumentConflictType, DocumentConflict, ConflictDetails, MergeabilityResult, DocumentDiff, MergePreview, MergeExecuteParams, MergeExecuteResult, MergeRequest, CreateMergeRequestParams, UpdateMergeRequestParams, ListMergeRequestsOptions, ExecuteMergeRequestOptions, Template, TemplateSummary, TemplateMetadata, TemplateContentItem, TemplateRootProps, CreateTemplateParams, UpdateTemplateParams, MigrationJob, MigrationConflict, MigrationPreview, MigrationPreviewDocument, TriggerMigrationParams, Datasource, QuerySortField, Query, QueryResultItem, QueryResultsMeta, QueryResults, QueryResultsParams, LocalePolicy, SiteLocales, SiteSettings, SiteSettingsResult, TranslationMode, LocalizationRelation, CreateTranslationParams, CreateTranslationResult, TranslationVariant, ListTranslationsResult, PropAuthority, AuthorityOverridesMap, AuthorityOverridesResult, ChangeClassification, ChangeSummaryEntry, ChangeSummary, UpstreamResolutions, UpstreamResolutionTarget, SiteMemberRole, AgentSiteRole, SiteMemberUser, SiteMemberAgent, SiteMembers, MergeJob, MergeJobStatus, } from './types/index.js';
 export type * from './types/threads/index.js';
 export type { RegistryComponent, RegistryComponentList } from './endpoints/registry.js';
 export { isAgentProposal, isAgentWorking } from './types/threads/index.js';

package/dist/sdk-version.d.ts

@@ -7,4 +7,4 @@
 /** Name half of `x-p1-sdk`. */
 export declare const SDK_NAME = "css-client";
 /** Version half of `x-p1-sdk`, matching the published release. */
-export declare const SDK_VERSION = "0.18.2";
+export declare const SDK_VERSION = "0.19.0";

package/dist/sdk-version.js

@@ -1,2 +1,2 @@
 export const SDK_NAME = 'css-client';
-export const SDK_VERSION = '0.18.2';
+export const SDK_VERSION = '0.19.0';

package/dist/types/index.d.ts

@@ -75,6 +75,21 @@ export interface Branch {
     createdAt: string;
     updatedAt: string;
 }
+/**
+ * A brief description of what a document holds, returned on a branch document
+ * listing when requested with `include: ['routeSummary']`.
+ */
+export interface DocumentRouteSummary {
+    /**
+     * `patch` is a page override entry, `page` is a full page, and `other` is any
+     * other content.
+     */
+    shape: 'patch' | 'page' | 'other';
+    /** The path a `patch` overrides. Present only when `shape` is `patch`. */
+    basePath?: string;
+    /** The number of operations in a `patch`. Present only when `shape` is `patch`. */
+    operationCount?: number;
+}
 /**
  * A document (page) within a site.
  */
@@ -98,6 +113,13 @@ export interface Document {
      * only on a branch document listing; absent elsewhere (get-by-id, get-by-path).
      */
     snapshotTitle?: string;
+    /**
+     * A summary of what the document holds, or `null` when it has no readable
+     * version on the branch or that version has empty content. Present only on a
+     * branch document listing that requested `include: ['routeSummary']`; servers
+     * that predate the option omit it.
+     */
+    routeSummary?: DocumentRouteSummary | null;
     /** Template this document is bound to (nullable for blank pages) */
     templateId?: string | null;
     /** Version of the template this document was created from or migrated to */
@@ -480,6 +502,8 @@ export interface PublishDocumentResult {
  */
 export interface ListDocumentsOptions extends PaginationOptions {
     pathPrefix?: string;
+    /** Extra data to return with each document. `routeSummary` adds `Document.routeSummary`. */
+    include?: 'routeSummary'[];
 }
 /**
  * Actor state in a document session.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pantheon-systems/css-client",
-  "version": "0.18.2",
+  "version": "0.19.0",
   "description": "TypeScript API client for Pantheon's P1 content platform",
   "publishConfig": {
     "access": "public",