@adobe/helix-config 3.13.1 → 4.0.0

package/types/site-config.d.ts

@@ -1,375 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-// NOTE: this file is autogenerated via 'npm run docs:types'
-
-export interface HelixSiteConfig {
-  version: 1;
-  /**
-   * Site name; part of the hostname
-   */
-  name?: string;
-  /**
-   * human readable title. has no influence on the configuration.
-   */
-  title?: string;
-  /**
-   * description for clarity. has no influence on the configuration.
-   */
-  description?: string;
-  content: ContentSource;
-  code: CodeSource;
-  folders?: Folders;
-  headers?: HelixHeadersConfig;
-  cdn?: CDNConfig;
-  access?: Access;
-  tokens?: Tokens;
-  groups?: Groups;
-  sidekick?: SidekickConfig;
-  metadata?: Metadata;
-  robots?: Robots;
-  public?: Public;
-  extends?: {
-    profile?: string;
-  };
-}
-/**
- * Defines the content bus location and source.
- */
-export interface ContentSource {
-  /**
-   * human readable title. has no influence on the configuration.
-   */
-  title?: string;
-  /**
-   * description for clarity. has no influence on the configuration.
-   */
-  description?: string;
-  contentBusId: string;
-  source: GoogleContentSource | OnedriveContentSource | MarkupContentSource;
-}
-export interface GoogleContentSource {
-  type: 'google';
-  url: string;
-  /**
-   * Google drive ID of the root folder; updated automatically when updating the url.
-   */
-  id: string;
-}
-export interface OnedriveContentSource {
-  type: 'onedrive';
-  url: string;
-  tenantId?: string;
-  /**
-   * onedrive item ID of the root folder; currently not required as we don't know how setup will work.
-   */
-  itemId?: string;
-}
-export interface MarkupContentSource {
-  type: 'markup';
-  url: string;
-  suffix?: string;
-}
-/**
- * Defines the code bus location and source.
- */
-export interface CodeSource {
-  /**
-   * human readable title. has no influence on the configuration.
-   */
-  title?: string;
-  /**
-   * description for clarity. has no influence on the configuration.
-   */
-  description?: string;
-  owner: string;
-  repo: string;
-  source: {
-    type: 'github';
-    url: string;
-  };
-  [k: string]: unknown;
-}
-export interface Folders {
-  /**
-   * This interface was referenced by `Folders`'s JSON-Schema definition
-   * via the `patternProperty` "^/[a-zA-Z0-9-/.]*$".
-   */
-  [k: string]: string;
-}
-export interface HelixHeadersConfig {
-  /**
-   * This interface was referenced by `HelixHeadersConfig`'s JSON-Schema definition
-   * via the `patternProperty` "^/[a-zA-Z0-9-/.]*\*{0,2}$".
-   */
-  [k: string]: KeyValuePair[];
-}
-export interface KeyValuePair {
-  key: string;
-  value: string;
-}
-export interface CDNConfig {
-  prod?: FastlyCDNConfig | CloudflareCDNConfig | AkamaiCDNConfig | ManagedCDNConfig | CloudfrontCDNConfig | EmptyConfig;
-  live?: {
-    /**
-     * Sidekick config to override the default preview host. it supports parameters $owner and $repo
-     */
-    host: string;
-  };
-  preview?: {
-    /**
-     * Sidekick config to override the default live host. it supports parameters $owner and $repo
-     */
-    host: string;
-  };
-}
-/**
- * Production CDN configuration for Fastly
- */
-export interface FastlyCDNConfig {
-  type: 'fastly';
-  /**
-   * production host
-   */
-  host: string;
-  /**
-   * Routes on the CDN that are rendered with Franklin
-   */
-  route?: string[];
-  /**
-   * The Fastly Service ID
-   */
-  serviceId: string;
-  /**
-   * A Fastly token for purging
-   */
-  authToken: string;
-}
-export interface CloudflareCDNConfig {
-  type: 'cloudflare';
-  /**
-   * production host
-   */
-  host: string;
-  /**
-   * Routes on the CDN that are rendered with Franklin
-   */
-  route?: string[];
-  plan: string;
-  zoneId: string;
-  apiToken: string;
-}
-export interface AkamaiCDNConfig {
-  type: 'akamai';
-  /**
-   * production host
-   */
-  host: string;
-  /**
-   * Routes on the CDN that are rendered with Franklin
-   */
-  route?: string[];
-  endpoint: string;
-  clientSecret: string;
-  clientToken: string;
-  accessToken: string;
-}
-export interface ManagedCDNConfig {
-  type: 'managed';
-  /**
-   * production host
-   */
-  host: string;
-  /**
-   * Routes on the CDN that are rendered with Franklin
-   */
-  route?: string[];
-}
-export interface CloudfrontCDNConfig {
-  type: 'cloudfront';
-  /**
-   * production host
-   */
-  host: string;
-  /**
-   * Routes on the CDN that are rendered with Franklin
-   */
-  route?: string[];
-  distributionId: string;
-  accessKeyId: string;
-  secretAccessKey: string;
-}
-export interface EmptyConfig {
-  /**
-   * production host
-   */
-  host: string;
-}
-export interface Access {
-  admin?: AdminAccessConfig;
-  site?: SiteAccessConfig;
-  preview?: SiteAccessConfig;
-  live?: SiteAccessConfig;
-}
-export interface AdminAccessConfig {
-  role?: Role;
-  /**
-   * Enforce authentication if set to true. If set to 'auto' it will enforce authentication if a role mapping is defined. defaults to 'auto'.
-   */
-  requireAuth?: boolean | 'auto';
-  /**
-   * the default roles assigned to the users. defaults to `basic_publish` for unauthenticated setups.
-   */
-  defaultRole?: (
-    | 'admin'
-    | 'author'
-    | 'publish'
-    | 'develop'
-    | 'basic_author'
-    | 'basic_publish'
-    | 'config'
-    | 'config_admin'
-  )[];
-  /**
-   * the id of the API key(s). this is used to validate the API KEYS and allows to invalidate them.
-   */
-  apiKeyId?: string[];
-}
-export interface Role {
-  /**
-   * The email glob of the users or a group reference for the respective role.
-   *
-   * This interface was referenced by `Role`'s JSON-Schema definition
-   * via the `patternProperty` "^[a-z-_]+$".
-   */
-  [k: string]: string[];
-}
-export interface SiteAccessConfig {
-  /**
-   * IDs of the api keys (tokens) that are allowed.
-   */
-  apiKeyId?: string[];
-  /**
-   * the DNs of the client certificates that are allowed.
-   */
-  clientCertDN?: string[];
-}
-export interface Tokens {
-  /**
-   * This interface was referenced by `Tokens`'s JSON-Schema definition
-   * via the `patternProperty` "^[a-zA-Z0-9-_=]+$".
-   */
-  [k: string]: {
-    id?: string;
-    hash?: string;
-    created?: string;
-  };
-}
-export interface Groups {
-  [k: string]: Group;
-}
-/**
- * A group of members. Can be referenced in access.admin.role.
- *
- * This interface was referenced by `Groups`'s JSON-Schema definition
- * via the `patternProperty` "^[a-zA-Z0-9-_=]+$".
- */
-export interface Group {
-  members: {
-    email: string;
-    name?: string;
-    [k: string]: unknown;
-  }[];
-}
-export interface SidekickConfig {
-  plugins?: SidekickPlugin[];
-  [k: string]: unknown;
-}
-export interface SidekickPlugin {
-  /**
-   * The unique plugin ID
-   */
-  id: string;
-  /**
-   * The button text
-   */
-  title?: string;
-  /**
-   * The URL to open when the button is clicked
-   */
-  url?: string;
-  /**
-   * The ID of the container to add this plugin to
-   */
-  containerId?: string;
-  /**
-   * The environments to display this plugin in
-   */
-  environments?: string & ('any' | 'dev' | 'admin' | 'edit' | 'preview' | 'live' | 'prod')[];
-  /**
-   * The name of a custom event to fire when the button is clicked (defaults to id)
-   */
-  event?: string;
-  /**
-   * Exclude the plugin from these paths
-   */
-  excludePaths?: string[];
-  /**
-   * Include the plugin on these paths (overrides excludePaths)
-   */
-  includePaths?: string[];
-  /**
-   * Turns the plugin into a container for other plugins
-   */
-  isContainer?: boolean;
-  /**
-   * Opens the URL in a palette instead of a new tab
-   */
-  isPalette?: boolean;
-  /**
-   * he dimensions and position of a palette box
-   */
-  paletteRect?: string;
-  /**
-   * The button text in other supported languages
-   */
-  titleI18n?: {
-    /**
-     * ISO language code (`en` or `en-US`) with translated button text
-     *
-     * This interface was referenced by `undefined`'s JSON-Schema definition
-     * via the `patternProperty` "^[a-z]{2}(-[A-Z]{2})?$".
-     */
-    [k: string]: string;
-  };
-  /**
-   * Append ref, repo, owner, host, and project as query params on new URL button click
-   */
-  passConfig?: boolean;
-  /**
-   * Append the referrer URL as a query param on new URL button click
-   */
-  passReferrer?: boolean;
-  [k: string]: unknown;
-}
-export interface Metadata {
-  source?: string[];
-}
-export interface Robots {
-  txt?: string;
-}
-/**
- * Public configuration
- */
-export interface Public {
-  [k: string]: unknown;
-}