feat: types for entity views (#1477)

Esri · Apr 18, 2024 · 89c6365 · 89c6365
1 parent a07470b
commit 89c6365
Show file tree

Hide file tree

Showing 11 changed files with 130 additions and 8 deletions.
diff --git a/package.json b/package.json
@@ -118,7 +118,7 @@
 		"docs:dev:acetate": "acetate server --log=debug --config docs/acetate.config.js --startPath hub.js/index.html",
 		"docs:dev:css": "cpx \"docs/src/css/*.css\" docs/build/hub.js/css",
 		"docs:dev:images": "cpx \"docs/src/**/*.{png,jpg,jpeg,gif,svg,webm,ogg}\" docs/build/hub.js -w",
-		"docs:dev:js": "cpx \"docs/src/**/{api-search,nav-toggle}.js\" docs/build/hub.js -w",
+		"docs:dev:js": "cpx \"docs/src/js/*.js\" docs/build/hub.js/js",
 		"docs:dev:typedoc": "onchange -v 'packages/*/src/**/*.ts' -- npm run docs:typedoc",
 		"docs:serve": "rimraf docs/build && concurrently \"npm run docs:dev:js\" \"npm run docs:dev:images\" \"npm run docs:dev:acetate\" \"npm run docs:dev:css\" \"npm run docs:dev:typedoc\"",
 		"docs:srihash": "node docs/generate-srihashes.js",

diff --git a/packages/common/src/core/traits/ICapabilityConfig.ts b/packages/common/src/core/traits/ICapabilityConfig.ts
@@ -0,0 +1,61 @@
+import { IFilter, IHubCatalog } from "../../search/types/IHubCatalog";
+
+export type HubCapability =
+  | "events"
+  | "content"
+  | "projects"
+  | "initiatives"
+  | "discussions"
+  | "pages";
+
+/**
+ * Configuration for a capability
+ * Typically extended by other interfaces
+ */
+export interface ICapabilityConfig {
+  enabled: boolean;
+  /**
+   * If defined, the filter will be injected into
+   * the entitie's content catalog's scope when the gallery is
+   * rendered
+   */
+  filter?: IFilter;
+  /**
+   * If defined, this catalog is used to render the gallery
+   */
+  catalog?: IHubCatalog;
+}
+/**
+ * We intentionally want these interfaces to exist even if they are empty
+ * as they are used to determine if a capability can be enabled
+ */
+/* tslint:disable: no-empty-interface */
+export interface IEventsConfig extends ICapabilityConfig {}
+export interface IProjectsConfig extends ICapabilityConfig {}
+export interface IInitiativesConfig extends ICapabilityConfig {}
+export interface IDiscussionsConfig extends ICapabilityConfig {}
+export interface IPagesConfig extends ICapabilityConfig {}
+/* tslint:enable: no-empty-interface */
+export interface IContentConfig extends ICapabilityConfig {
+  feeds?: any; // TODO: lookup the type as this is defined somewhere
+}
+
+export interface IWithEvents {
+  events?: IEventsConfig;
+}
+
+export interface IWithProjects {
+  projects?: IProjectsConfig;
+}
+
+export interface IWithInitiatives {
+  initiatives?: IInitiativesConfig;
+}
+
+export interface IWithPages {
+  pages?: IPagesConfig;
+}
+
+export interface IWithContent {
+  content?: IContentConfig;
+}
diff --git a/packages/common/src/core/traits/index.ts b/packages/common/src/core/traits/index.ts
@@ -6,3 +6,4 @@ export * from "./IWithPermissions";
 export * from "./IWithCatalog";
 export * from "./IWithViewSettings";
 export * from "./IWithDiscussions";
+export * from "./ICapabilityConfig";
diff --git a/packages/common/src/core/types/IHubProject.ts b/packages/common/src/core/types/IHubProject.ts
@@ -1,11 +1,11 @@
+import { IWithCatalog } from "../traits/IWithCatalog";
+import { IWithLayout } from "../traits/IWithLayout";
 import { IWithMetrics } from "../traits/IWithMetrics";
+import { IWithPermissions } from "../traits/IWithPermissions";
+import { IWithSlug } from "../traits/IWithSlug";
 import { IWithStatus } from "../traits/IWithStatus";
-import {
-  IWithLayout,
-  IWithPermissions,
-  IWithSlug,
-  IWithCatalog,
-} from "../traits/index";
+import { IWithContent, IWithEvents } from "../traits/ICapabilityConfig";
+
 import { IHubItemEntity, IHubItemEntityEditor } from "./IHubItemEntity";
 
 /**
@@ -18,6 +18,8 @@ export interface IHubProject
     IWithLayout,
     IWithMetrics,
     IWithPermissions,
+    IWithEvents,
+    IWithContent,
     IWithStatus {}
 
 /**

diff --git a/packages/common/src/events/_internal/EventBusinessRules.ts b/packages/common/src/events/_internal/EventBusinessRules.ts
@@ -20,6 +20,7 @@ export const EventPermissions = [
   "hub:event:workspace:collaborators",
   "hub:event:workspace:manage",
   "hub:event:workspace:attendees",
+  "hub:event:workspace:content",
   "hub:event:manage",
 ] as const;
 
@@ -110,6 +111,10 @@ export const EventPermissionPolicies: IPermissionPolicy[] = [
     permission: "hub:event:workspace:attendees",
     dependencies: ["hub:event:workspace", "hub:event:edit"],
   },
+  {
+    permission: "hub:event:workspace:content",
+    dependencies: ["hub:event:workspace", "hub:event:edit"],
+  },
   {
     permission: "hub:event:manage",
     dependencies: ["hub:event:edit"],

diff --git a/packages/common/src/initiatives/_internal/InitiativeBusinessRules.ts b/packages/common/src/initiatives/_internal/InitiativeBusinessRules.ts
@@ -36,6 +36,7 @@ export const InitiativePermissions = [
   "hub:initiative:workspace:settings",
   "hub:initiative:workspace:collaborators",
   "hub:initiative:workspace:content",
+  "hub:initiative:workspace:events",
   "hub:initiative:workspace:metrics",
   "hub:initiative:workspace:associationGroup:create",
   "hub:initiative:manage",
@@ -175,6 +176,12 @@ export const InitiativePermissionPolicies: IPermissionPolicy[] = [
   {
     permission: "hub:initiative:workspace:content",
     dependencies: ["hub:initiative:workspace", "hub:initiative:edit"],
+    availability: ["alpha"],
+  },
+  {
+    permission: "hub:initiative:workspace:events",
+    dependencies: ["hub:initiative:workspace", "hub:initiative:edit"],
+    availability: ["alpha"],
   },
   {
     permission: "hub:initiative:workspace:metrics",

diff --git a/packages/common/src/initiatives/_internal/getPropertyMap.ts b/packages/common/src/initiatives/_internal/getPropertyMap.ts
@@ -19,6 +19,10 @@ export function getPropertyMap(): IPropertyMap[] {
   map.push({ entityKey: "contacts", storeKey: "data.contacts" });
   map.push({ entityKey: "timeline", storeKey: "data.timeline" });
 
+  // Capabilities
+  map.push({ entityKey: "content", storeKey: "data.content" });
+  map.push({ entityKey: "events", storeKey: "data.events" });
+
   // Deeper/Indirect mappings
   map.push({ entityKey: "metrics", storeKey: "item.properties.metrics" });
 

diff --git a/packages/common/src/projects/_internal/ProjectBusinessRules.ts b/packages/common/src/projects/_internal/ProjectBusinessRules.ts
@@ -34,6 +34,7 @@ export const ProjectPermissions = [
   "hub:project:workspace:settings",
   "hub:project:workspace:collaborators",
   "hub:project:workspace:content",
+  "hub:project:workspace:events",
   "hub:project:workspace:metrics",
   "hub:project:manage",
 ] as const;
@@ -151,6 +152,12 @@ export const ProjectPermissionPolicies: IPermissionPolicy[] = [
   {
     permission: "hub:project:workspace:content",
     dependencies: ["hub:project:workspace", "hub:project:edit"],
+    availability: ["alpha"],
+  },
+  {
+    permission: "hub:project:workspace:events",
+    dependencies: ["hub:project:workspace", "hub:project:edit"],
+    availability: ["alpha"],
   },
   {
     permission: "hub:project:workspace:metrics",

diff --git a/packages/common/src/projects/_internal/getPropertyMap.ts b/packages/common/src/projects/_internal/getPropertyMap.ts
@@ -10,10 +10,16 @@ import { getBasePropertyMap } from "../../core/_internal/getBasePropertyMap";
 
 export function getPropertyMap(): IPropertyMap[] {
   const map = getBasePropertyMap();
-
   // Type specific mappings
   map.push({ entityKey: "status", storeKey: "data.status" });
+
+  // TOOD: Remove catalog and swap to using the content-capability-pane in the UI
   map.push({ entityKey: "catalog", storeKey: "data.catalog" });
+
+  // Capabilities
+  map.push({ entityKey: "content", storeKey: "data.content" });
+  map.push({ entityKey: "events", storeKey: "data.events" });
+
   map.push({ entityKey: "permissions", storeKey: "data.permissions" });
   map.push({
     entityKey: "features",

diff --git a/packages/common/src/sites/_internal/SiteBusinessRules.ts b/packages/common/src/sites/_internal/SiteBusinessRules.ts
@@ -41,6 +41,10 @@ export const SitePermissions = [
   "hub:site:workspace:followers:manager",
   "hub:site:workspace:followers:create",
   "hub:site:workspace:discussion",
+  "hub:site:workspace:pages",
+  "hub:site:workspace:events",
+  "hub:site:workspace:projects",
+  "hub:site:workspace:initiatives",
   "hub:site:manage",
 ] as const;
 
@@ -150,6 +154,16 @@ export const SitesPermissionPolicies: IPermissionPolicy[] = [
     permission: "hub:site:workspace:content",
     dependencies: ["hub:site:workspace", "hub:site:edit"],
   },
+  {
+    permission: "hub:site:workspace:pages",
+    dependencies: ["hub:site:workspace", "hub:site:edit"],
+    availability: ["alpha"],
+  },
+  {
+    permission: "hub:site:workspace:events",
+    dependencies: ["hub:site:workspace", "hub:site:edit"],
+    availability: ["alpha"],
+  },
   {
     permission: "hub:site:workspace:metrics",
     dependencies: ["hub:site:workspace", "hub:site:edit"],
@@ -198,6 +212,16 @@ export const SitesPermissionPolicies: IPermissionPolicy[] = [
     permission: "hub:site:workspace:discussion",
     dependencies: ["hub:site:workspace", "hub:site:edit"],
   },
+  {
+    permission: "hub:site:workspace:projects",
+    dependencies: ["hub:site:workspace", "hub:site:edit"],
+    availability: ["alpha"],
+  },
+  {
+    permission: "hub:site:workspace:initiatives",
+    dependencies: ["hub:site:workspace", "hub:site:edit"],
+    availability: ["alpha"],
+  },
   {
     permission: "hub:site:manage",
     dependencies: ["hub:site:edit"],

diff --git a/packages/common/src/sites/_internal/getPropertyMap.ts b/packages/common/src/sites/_internal/getPropertyMap.ts
@@ -31,6 +31,11 @@ export function getPropertyMap(): IPropertyMap[] {
   valueProps.forEach((entry) => {
     map.push({ entityKey: entry, storeKey: `data.values.${entry}` });
   });
+  // Capabilities
+  map.push({ entityKey: "events", storeKey: "data.events" });
+  map.push({ entityKey: "initiatives", storeKey: "data.initiatives" });
+  map.push({ entityKey: "projects", storeKey: "data.projects" });
+
   // Deeper/Indirect mappings
   map.push({
     entityKey: "slug",