@favish/staffbase-utils 0.8.0 → 0.9.0

package/README.md

@@ -25,6 +25,7 @@ minimumReleaseAgeExclude:
 | --- | --- |
 | `@favish/staffbase-utils/log` | `logError`, `logWarn`, `logDebug`, `setLoggingEnabled` |
 | `@favish/staffbase-utils/dom` | `getDynamicClasses` |
+| `@favish/staffbase-utils/types` | `Channel`, `ChannelLink`, `ChannelLinkParameter`, `DropdownOption` (type-only) |
 
 More modules (`/env`, `/device`, `/html`, `/links`, `/widgets`) are added per the
 delivery roadmap; each is its own subpath so consumers only bundle what they import.

package/dist/src/types/content/Channel.d.ts

@@ -0,0 +1,70 @@
+import { ChannelLink } from './ChannelLink';
+/**
+ * Partial shape of a Staffbase content channel as returned by the channels API.
+ *
+ * Shared verbatim by the alerts, unacknowledged-bulletins and global-content
+ * widgets. The smart-search widget consumes a different (search-API) channel
+ * shape and keeps its own type. Marked partial because the platform may add
+ * fields; only the documented subset the widgets rely on is typed here.
+ */
+export interface Channel {
+    pluginID: string;
+    menuFolderIDs: string[];
+    defaultMenuFolderId: string;
+    config: {
+        localization: Record<string, {
+            title: string;
+            description: string | null;
+        }>;
+        sidebarVisible: boolean;
+        showPageBackground: boolean;
+        showAdminActions: boolean;
+    };
+    availableInPublicArea: boolean;
+    contentType: string;
+    notificationChannelsAllowed: string[] | null;
+    notificationChannelsDefault: string[];
+    postCount: number;
+    id: string;
+    spaceID: string;
+    visibleInPublicArea: boolean;
+    displayAuthor: boolean;
+    acknowledgingAllowed: boolean;
+    commentingAllowed: boolean;
+    highlightingAllowed: boolean;
+    layout: {
+        primaryMedia: string;
+    };
+    likingAllowed: boolean;
+    sharingAllowed: boolean;
+    internalSharingAllowed: boolean;
+    externalSharingAllowed: boolean;
+    lastPostPublishedAt: string;
+    commentingEnabledDefault: boolean;
+    highlightingEnabledDefault: boolean;
+    likingEnabledDefault: boolean;
+    sharingEnabledDefault: boolean;
+    acknowledgingEnabledDefault: boolean;
+    internalSharingEnabledDefault: boolean;
+    externalSharingEnabledDefault: boolean;
+    published: string;
+    created: string;
+    entityType: string;
+    updated: string;
+    links: {
+        preview: ChannelLink;
+        create_post: ChannelLink;
+        move: ChannelLink;
+        accessors: ChannelLink;
+        available_news_pages: ChannelLink;
+        get_posts: ChannelLink;
+        menu_items: ChannelLink;
+        update: ChannelLink;
+        feeds: ChannelLink;
+        delete: ChannelLink;
+        users: ChannelLink;
+        update_news_pages: ChannelLink;
+    };
+    rights: string[];
+}
+//# sourceMappingURL=Channel.d.ts.map

package/dist/src/types/content/Channel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Channel.d.ts","sourceRoot":"","sources":["../../../../src/types/content/Channel.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAEhD;;;;;;;GAOG;AACH,MAAM,WAAW,OAAO;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,MAAM,EAAE,CAAA;IACvB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,MAAM,EAAE;QACN,YAAY,EAAE,MAAM,CAClB,MAAM,EACN;YACE,KAAK,EAAE,MAAM,CAAA;YACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;SAC3B,CACF,CAAA;QACD,cAAc,EAAE,OAAO,CAAA;QACvB,kBAAkB,EAAE,OAAO,CAAA;QAC3B,gBAAgB,EAAE,OAAO,CAAA;KAC1B,CAAA;IACD,qBAAqB,EAAE,OAAO,CAAA;IAC9B,WAAW,EAAE,MAAM,CAAA;IACnB,2BAA2B,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;IAC5C,2BAA2B,EAAE,MAAM,EAAE,CAAA;IACrC,SAAS,EAAE,MAAM,CAAA;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IACf,mBAAmB,EAAE,OAAO,CAAA;IAC5B,aAAa,EAAE,OAAO,CAAA;IACtB,oBAAoB,EAAE,OAAO,CAAA;IAC7B,iBAAiB,EAAE,OAAO,CAAA;IAC1B,mBAAmB,EAAE,OAAO,CAAA;IAC5B,MAAM,EAAE;QACN,YAAY,EAAE,MAAM,CAAA;KACrB,CAAA;IACD,aAAa,EAAE,OAAO,CAAA;IACtB,cAAc,EAAE,OAAO,CAAA;IACvB,sBAAsB,EAAE,OAAO,CAAA;IAC/B,sBAAsB,EAAE,OAAO,CAAA;IAC/B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,wBAAwB,EAAE,OAAO,CAAA;IACjC,0BAA0B,EAAE,OAAO,CAAA;IACnC,oBAAoB,EAAE,OAAO,CAAA;IAC7B,qBAAqB,EAAE,OAAO,CAAA;IAC9B,2BAA2B,EAAE,OAAO,CAAA;IACpC,6BAA6B,EAAE,OAAO,CAAA;IACtC,6BAA6B,EAAE,OAAO,CAAA;IACtC,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE;QACL,OAAO,EAAE,WAAW,CAAA;QACpB,WAAW,EAAE,WAAW,CAAA;QACxB,IAAI,EAAE,WAAW,CAAA;QACjB,SAAS,EAAE,WAAW,CAAA;QACtB,oBAAoB,EAAE,WAAW,CAAA;QACjC,SAAS,EAAE,WAAW,CAAA;QACtB,UAAU,EAAE,WAAW,CAAA;QACvB,MAAM,EAAE,WAAW,CAAA;QACnB,KAAK,EAAE,WAAW,CAAA;QAClB,MAAM,EAAE,WAAW,CAAA;QACnB,KAAK,EAAE,WAAW,CAAA;QAClB,iBAAiB,EAAE,WAAW,CAAA;KAC/B,CAAA;IACD,MAAM,EAAE,MAAM,EAAE,CAAA;CACjB"}

package/dist/src/types/content/ChannelLink.d.ts

@@ -0,0 +1,12 @@
+import { ChannelLinkParameter } from './ChannelLinkParameter';
+/**
+ * A single HAL link on a channel (method + href, with optional parameter and
+ * form descriptors). Used for each entry of a channel's `links` map.
+ */
+export interface ChannelLink {
+    method: string;
+    href: string;
+    parameters?: Record<string, ChannelLinkParameter>;
+    form?: ChannelLinkParameter[];
+}
+//# sourceMappingURL=ChannelLink.d.ts.map

package/dist/src/types/content/ChannelLink.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChannelLink.d.ts","sourceRoot":"","sources":["../../../../src/types/content/ChannelLink.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAElE;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAA;IACjD,IAAI,CAAC,EAAE,oBAAoB,EAAE,CAAA;CAC9B"}

package/dist/src/types/content/ChannelLinkParameter.d.ts

@@ -0,0 +1,13 @@
+/**
+ * A single parameter descriptor on a channel HAL link (an entry in a link's
+ * `parameters` map or `form` array). Mirrors the Staffbase channels API; the
+ * alerts, unacknowledged-bulletins and global-content widgets share this shape.
+ */
+export interface ChannelLinkParameter {
+    type: string;
+    id: string;
+    format?: string;
+    value?: string | number;
+    required: boolean;
+}
+//# sourceMappingURL=ChannelLinkParameter.d.ts.map

package/dist/src/types/content/ChannelLinkParameter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChannelLinkParameter.d.ts","sourceRoot":"","sources":["../../../../src/types/content/ChannelLinkParameter.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACvB,QAAQ,EAAE,OAAO,CAAA;CAClB"}

package/dist/src/types/content/DropdownOption.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Option shape for channel/article selector dropdowns.
+ *
+ * `spaceName` and `spaceId` are optional enrichment used by widgets that group
+ * options by space; widgets that do not group simply omit them. This is the
+ * superset of the alerts (id/title) and unacknowledged-bulletins (+space)
+ * variants.
+ */
+export interface DropdownOption {
+    id: string;
+    title: string;
+    /** Optional space name for display in selectors. */
+    spaceName?: string;
+    /** Optional space id for enrichment. */
+    spaceId?: string;
+}
+//# sourceMappingURL=DropdownOption.d.ts.map

package/dist/src/types/content/DropdownOption.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DropdownOption.d.ts","sourceRoot":"","sources":["../../../../src/types/content/DropdownOption.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,oDAAoD;IACpD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,wCAAwC;IACxC,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB"}

package/dist/src/types/content/index.d.ts

@@ -0,0 +1,5 @@
+export type { Channel } from './Channel';
+export type { ChannelLink } from './ChannelLink';
+export type { ChannelLinkParameter } from './ChannelLinkParameter';
+export type { DropdownOption } from './DropdownOption';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/types/content/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/types/content/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACxC,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,YAAY,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAClE,YAAY,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA"}

package/dist/types.cjs.js

@@ -0,0 +1 @@
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@favish/staffbase-utils",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "Shared internal/host utilities for Staffbase widgets",
   "author": "Favish <dev@favish.com>",
   "license": "UNLICENSED",
@@ -42,6 +42,11 @@
       "types": "./dist/src/widgets/react/index.d.ts",
       "import": "./dist/widgets/react.es.mjs",
       "require": "./dist/widgets/react.cjs.js"
+    },
+    "./types": {
+      "types": "./dist/src/types/content/index.d.ts",
+      "import": "./dist/types.es.mjs",
+      "require": "./dist/types.cjs.js"
     }
   },
   "repository": {