@esri/hub-common 14.222.0 → 14.224.0

package/dist/types/sites/feed-configuration.d.ts

@@ -1,6 +1,7 @@
 import { IModel } from "../types";
 declare type FeedFormat = "dcat-us" | "dcat-ap" | "rss";
 /**
+ * DEPRECATED: This will be removed in the next breaking version. use `getFeedTemplate()` instead
  * Returns feed configuration from a site model
  *
  * @param {IModel} site - site model
@@ -9,6 +10,7 @@ declare type FeedFormat = "dcat-us" | "dcat-ap" | "rss";
  */
 export declare function getFeedConfiguration(site: IModel, format: FeedFormat, version: string): any;
 /**
+ * DEPRECATED: This will be removed in the next breaking version. Use `setFeedTemplate()` instead;
  * Returns feed configuration from a site model
  *
  * @param {IModel} site - site model

package/dist/types/sites/feeds/_internal/defaults.d.ts

@@ -0,0 +1,5 @@
+import { FeedFormat } from "../types";
+/**
+ * Returns the default templates for each supported major version of each feed format
+ */
+export declare function getDefaultTemplates(): Record<FeedFormat, Record<string, any>>;

package/dist/types/sites/feeds/_internal/getMajorVersion.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @private
+ * Get the major version from a semantic version string
+ *
+ * @param version dot delimited semantic version
+ * @returns the major version of the semantic version
+ */
+export declare function getMajorVersion(version: string): string;

package/dist/types/sites/feeds/getFeedTemplate.d.ts

@@ -0,0 +1,15 @@
+import { FeedFormat, IFeedsConfiguration } from "./types";
+export interface IGetFeedTemplateOptions {
+    feedsConfig: IFeedsConfiguration;
+    format: FeedFormat;
+    version: string;
+}
+/**
+ * Get the feed template for a given feed format and version, accounting
+ * for version fallbacks and default templates as necessary.
+ * @param opts.feedConfig - the raw feeds configuration object
+ * @param opts.format - the feed format
+ * @param opts.version - the feed version
+ * @returns a feed template object
+ */
+export declare function getFeedTemplate(opts: IGetFeedTemplateOptions): Record<string, any>;

package/dist/types/sites/feeds/previewFeed.d.ts

@@ -0,0 +1,19 @@
+import { IArcGISContext } from "../../ArcGISContext";
+import { FeedFormat } from "./types";
+export interface IPreviewFeedOptions {
+    format: FeedFormat;
+    version: string;
+    previewTemplate: Record<string, any>;
+    previewHubId: string;
+    context: IArcGISContext;
+}
+/**
+ * Preview a feed using the provided template and context
+ * @param opts.format - the feed format
+ * @param opts.version - the feed version
+ * @param opts.previewTemplate - the feed template to preview
+ * @param opts.previewHubId - the Hub ID to preview the feed for
+ * @param opts.context - the ArcGIS context
+ * @returns the previewed feed as a string
+ */
+export declare function previewFeed(opts: IPreviewFeedOptions): Promise<string>;

package/dist/types/sites/feeds/setFeedTemplate.d.ts

@@ -0,0 +1,17 @@
+import { FeedFormat, IFeedsConfiguration } from "./types";
+export interface ISetFeedTemplateOptions {
+    feedsConfig: IFeedsConfiguration;
+    format: FeedFormat;
+    version: string;
+    updatedTemplate: Record<string, any>;
+}
+/**
+ * Sets the feed template for a given feed format and version. Always use this function
+ * to update feed templates rather than interacting with the feeds configuration object directly.
+ * @param opts.feedsConfig - the raw feeds configuration object
+ * @param opts.format - the feed format
+ * @param opts.version - the feed version
+ * @param opts.updatedTemplate - the updated feed template
+ * @returns a new feeds configuration object with the updated template
+ */
+export declare function setFeedTemplate(opts: ISetFeedTemplateOptions): Record<string, any>;

package/dist/types/sites/feeds/types.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Represents the feed format types that are supported in Hub
+ */
+export declare type FeedFormat = "dcat-us" | "dcat-ap" | "rss";
+/**
+ * Configuration object for feeds. Stores feed templates for various feed formats and versions
+ * as well as miscellaneous configuration options. Always interact with this object through the
+ * configuration helpers (getFeedTemplate(), setFeedTemplate(), etc.) when possible.
+ */
+export interface IFeedsConfiguration extends IWithFeedTemplatePaths {
+    /**
+     * Whether or not the feeds capability as a whole has been disabled
+     */
+    disabled?: boolean;
+}
+declare type IWithFeedTemplatePaths = Partial<Record<FeedTemplatePath, Record<string, any>>>;
+declare type FeedTemplatePath = DcatUSTemplatePaths | DcatAPTemplatePaths | RssTemplatePaths;
+declare type DcatUSTemplatePaths = "dcatUS11" | "dcatUS1X";
+declare type DcatAPTemplatePaths = "dcatAP201" | "dcatAP2XX";
+declare type RssTemplatePaths = "rss2";
+export {};

package/dist/types/sites/index.d.ts

@@ -16,3 +16,7 @@ export * from "./themes";
 export * from "./upgrade-site-schema";
 export * from "./feed-configuration";
 export * from "./reharvestSiteCatalog";
+export * from "./feeds/getFeedTemplate";
+export * from "./feeds/setFeedTemplate";
+export * from "./feeds/previewFeed";
+export * from "./feeds/types";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "14.222.0",
+  "version": "14.224.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",