improve types for documentation

Author: ricardo-devis-agullo

packages/oc-azure-storage-adapter/src/index.ts

@@ -36,9 +36,27 @@ async function streamToBuffer(readableStream: NodeJS.ReadableStream) {
 }
 
 export interface AzureConfig extends StorageAdapterBaseConfig {
+  /**
+   * Name of the **public** Azure Blob container that will host the static,
+   * publicly accessible files of a component (css, js, templates, etc.).
+   */
   publicContainerName: string;
+
+  /**
+   * Name of the **private** Azure Blob container that will host files that must
+   * not be publicly accessible (e.g. `server.js`, dot-files, etc.).
+   */
   privateContainerName: string;
+
+  /**
+   * Azure Storage account name that owns the containers.
+   */
   accountName: string;
+
+  /**
+   * Access key for the storage account. If **omitted**, the adapter falls back
+   * to Azure's default credential chain (`DefaultAzureCredential`). Optional.
+   */
   accountKey?: string;
 }
 

packages/oc-gs-storage-adapter/src/index.ts

@@ -17,8 +17,18 @@ const getPaths: (path: string) => Promise<PathsResult> = promisify(
 );
 
 export interface GsConfig extends StorageAdapterBaseConfig {
+  /**
+   * Name of the Google Cloud Storage bucket that will host the component files.
+   */
   bucket: string;
+  /**
+   * Google Cloud project ID that owns the bucket.
+   */
   projectId: string;
+  /**
+   * Cache-Control max-age (in seconds) to apply to public files. If not set, defaults to 3600.
+   * Optional.
+   */
   maxAge?: boolean;
 }
 

packages/oc-s3-storage-adapter/src/index.ts

@@ -34,15 +34,25 @@ type RequireAllOrNone<ObjectType, KeysType extends keyof ObjectType = never> = (
 export type S3Config = StorageAdapterBaseConfig &
   RequireAllOrNone<
     {
+      /** Name of the AWS S3 bucket where components will be stored. */
       bucket: string;
+      /** AWS region where the bucket is located (e.g. "eu-west-1"). */
       region: string;
+      /** AWS access key ID. Must be provided together with `secret`, or both omitted to use IAM role credentials. */
       key?: string;
+      /** AWS secret access key. Must be provided together with `key`, or both omitted to use IAM role credentials. */
       secret?: string;
+      /** When `false`, disables SSL for S3 requests. Defaults to `true`. Optional. */
       sslEnabled?: boolean;
+      /** Force path-style URLs instead of virtual host style. Optional. */
       s3ForcePathStyle?: boolean;
+      /** Socket timeout (in milliseconds) for S3 requests. Optional. */
       timeout?: number;
+      /** Custom HTTP/HTTPS agent to use (e.g. proxy agent). Optional. */
       agentProxy?: httpAgent | httpsAgent;
+      /** Custom S3 endpoint (useful for S3-compatible services or local testing). Optional. */
       endpoint?: string;
+      /** When `true`, enables AWS SDK debug logging to the console. Optional. */
       debug?: boolean;
     },
     'key' | 'secret'

packages/oc-storage-adapters-utils/src/index.ts

@@ -4,9 +4,28 @@ export { getNextYear } from './get-next-year';
 export * as strings from './strings';
 
 export interface StorageAdapterBaseConfig {
+  /**
+   * Local folder that contains the compiled OC components ready to be uploaded
+   * to the storage provider.
+   */
   componentsDir: string;
+
+  /**
+   * Public CDN prefix where components will be served from (for example,
+   * "https://cdn.myorg.com/"). Adapters use this to build the URLs returned by
+   * `getUrl()`.
+   */
   path: string;
+
+  /**
+   * When set to `true`, enables verbose logging during adapter operations such
+   * as upload or removal. Optional.
+   */
   verbosity?: boolean;
+
+  /**
+   * Time-to-live for the in-memory cache, in milliseconds. Optional.
+   */
   refreshInterval?: number;
 }