@streamscloud/streams-analytics-collector 1.0.0

package/dist/services/types.d.ts

@@ -0,0 +1,303 @@
+import { MediaItem } from '../types';
+export type EmbedContentApiClientModel = {
+    streamsGqlEndpoint: string;
+};
+export type EmbedPostsInput = {
+    filter: EmbedPostsFilterInput;
+};
+export type EmbedStreamsInput = {
+    filter: EmbedPostsFilterInput;
+};
+export interface Media {
+    type: MediaType;
+    url: string;
+    thumbnailUrl: string | null;
+}
+export type EmbedPostsFilterInput = {
+    ids: string[];
+};
+export type EmbedPostsData = {
+    embedPosts: CursorResultOfPost;
+};
+export type EmbedStreamsFilterInput = {
+    ids: string[];
+};
+export type EmbedStreamsData = {
+    embedStreams: CursorResultOfStreams;
+};
+export type GqlResponse<T> = {
+    data?: T;
+    errors?: unknown;
+};
+export type ContentMediaItem = IMediaItem & {
+    blobId: string;
+    mediaPageTags?: MediaPageTagPosition[];
+    metadata: MediaItemMetadata;
+    thumbnailBlobId?: string;
+    thumbnailUrl: string | null;
+    type: MediaType;
+    url: string;
+    userTags?: UserTagPosition[];
+};
+export type CtaButton = {
+    background: string;
+    border: string;
+    text: string;
+    textColor: string;
+    url: string;
+};
+export type IMediaItem = {
+    blobId: string;
+    metadata: MediaItemMetadata;
+    thumbnailBlobId?: string;
+    thumbnailUrl?: string;
+    type: MediaType;
+    url: string;
+};
+export declare enum MediaFormat {
+    W4H3 = "W4H3",
+    W16H9 = "W16H9"
+}
+export type MediaItemMetadata = {
+    durationSec?: number;
+    fileName?: string;
+    height: number;
+    width: number;
+};
+export type MediaPageTag = {
+    handle: string;
+    id: string;
+    image?: string;
+    name: string;
+};
+export type MediaPageTagPosition = TagPosition & {
+    itemId: string;
+    leftPCT: number;
+    mediaPage?: MediaPageTag;
+    topPCT: number;
+};
+export type MediaPostData = {
+    ctaButton?: CtaButton;
+    preferredMediaFormat: MediaFormat;
+    text?: string;
+};
+export declare enum MediaType {
+    Audio = "AUDIO",
+    Image = "IMAGE",
+    ShortVideo = "SHORT_VIDEO",
+    Video = "VIDEO"
+}
+export type MomentInfo = {
+    author: Profile;
+    cover: string;
+    displayDate: Date;
+    id: string;
+    isSeen: boolean;
+    text?: string;
+};
+export declare enum MomentLifetime {
+    Day = "DAY",
+    Week = "WEEK"
+}
+export type MomentPostData = {
+    lifetime: MomentLifetime;
+    text?: string;
+};
+export type MomentsContainerInfo = {
+    hideIfNoMoments: boolean;
+    image?: ScaledImageBlob;
+    momentsEnabled: boolean;
+    primaryColor?: string;
+    targetId: string;
+    targetType: PublishTargetType;
+    useImageAsMomentsCover: boolean;
+};
+export type MomentsInfo = {
+    containerInfo: MomentsContainerInfo;
+    moments: MomentInfo[];
+    unseenMomentsCount: number;
+};
+export type CursorResultOfStreams = {
+    continuationToken?: string;
+    items: Stream[];
+};
+export type CursorResultOfPost = {
+    continuationToken?: string;
+    items: Post[];
+};
+export type Post = {
+    authorProfile: Profile;
+    createdAt: Date;
+    createdBy: string;
+    displayDate: Date;
+    editorProfile: Profile;
+    enableSocialInteractions: boolean;
+    expiresOn?: Date;
+    generatedName: string;
+    id: string;
+    isPinned: boolean;
+    isSeen: boolean;
+    language: string;
+    mainImage?: string;
+    ownerProfile: Profile;
+    postData: PostData;
+    postHeading: PostHeading;
+    postProfile: Profile;
+    postType: PostType;
+    publishedTo?: PublishTarget;
+    scheduledOn?: Date;
+    sharesCount: number;
+    showInFeed: boolean;
+    social?: PostSocialInteractions;
+    status: Status;
+    updatedAt: Date;
+    updatedBy: string;
+    userReaction?: Reaction;
+    viewsCount: number;
+};
+export type PostData = {
+    media: ContentMediaItem[];
+    mediaData?: MediaPostData;
+    momentData?: MomentPostData;
+    postType: PostType;
+    shortVideoData?: ShortVideoPostData;
+    textData?: TextPostData;
+    videoData?: VideoPostData;
+};
+export type PostHeading = {
+    networkData?: PostHeadingNetworkTargetData;
+    postDisplayDate: string;
+    postViewsCount: number;
+    sourceHandle: string;
+    sourceId: string;
+    sourceImage?: string;
+    sourceIsRemoved: boolean;
+    sourceName: string;
+    sourceType: PostSourceType;
+    wasModified: boolean;
+};
+export type PostHeadingNetworkTargetData = {
+    momentsInfo: MomentsInfo;
+    primaryColor?: string;
+};
+export type PostSocialInteractions = {
+    commentsCount: number;
+    reactions: ReactionsCount;
+    sharesCount: number;
+};
+export declare enum PostSourceType {
+    Channel = "CHANNEL",
+    Group = "GROUP",
+    MediaPage = "MEDIA_PAGE",
+    Organization = "ORGANIZATION",
+    UserProfile = "USER_PROFILE"
+}
+export declare enum PostType {
+    Article = "ARTICLE",
+    Audio = "AUDIO",
+    Event = "EVENT",
+    Link = "LINK",
+    Media = "MEDIA",
+    Moment = "MOMENT",
+    ShortVideo = "SHORT_VIDEO",
+    Text = "TEXT",
+    Video = "VIDEO"
+}
+export type Profile = {
+    __typename?: 'Profile';
+    handle: string;
+    id: string;
+    image?: string;
+    isRemoved: boolean;
+    name: string;
+    type: ProfileType;
+};
+export declare enum ProfileType {
+    Channel = "CHANNEL",
+    Group = "GROUP",
+    Organization = "ORGANIZATION",
+    User = "USER"
+}
+export type PublishTarget = {
+    enableMoments: boolean;
+    enablePostsSocialInteractionsByDefault: boolean;
+    id: string;
+    image?: string;
+    isRemoved: boolean;
+    momentsLifetime: MomentLifetime;
+    name: string;
+    primaryColor?: string;
+    targetContentOwnerProfile?: Profile;
+    type: PublishTargetType;
+};
+export declare enum PublishTargetType {
+    Channel = "CHANNEL",
+    Group = "GROUP",
+    MediaPage = "MEDIA_PAGE",
+    User = "USER"
+}
+export declare enum ReactableType {
+    ChatMessage = "CHAT_MESSAGE",
+    Comment = "COMMENT",
+    CommunityMessage = "COMMUNITY_MESSAGE",
+    Post = "POST"
+}
+export type Reaction = {
+    code: string;
+    id: string;
+    reactableId: string;
+    reactableType: ReactableType;
+    userProfile: Profile;
+};
+export type ReactionCodeCount = {
+    code: string;
+    count: number;
+};
+export type ReactionsCount = {
+    perCode: ReactionCodeCount[];
+    total: number;
+};
+export type ScaledImageBlob = {
+    id: string;
+    url: string;
+};
+export type ShortVideoPostData = {
+    text?: string;
+};
+export declare enum Status {
+    Archived = "ARCHIVED",
+    Draft = "DRAFT",
+    Published = "PUBLISHED",
+    Scheduled = "SCHEDULED"
+}
+export type Stream = {
+    id: string;
+    cover: MediaItem;
+};
+export type TagPosition = {
+    itemId: string;
+    leftPCT: number;
+    topPCT: number;
+};
+export type TextPostData = {
+    ctaButton?: CtaButton;
+    text: string;
+};
+export type UserTag = {
+    id: string;
+    image: string;
+    name: string;
+    username?: string;
+};
+export type UserTagPosition = TagPosition & {
+    itemId: string;
+    leftPCT: number;
+    topPCT: number;
+    user?: UserTag;
+};
+export type VideoPostData = {
+    preferredMediaFormat: MediaFormat;
+    text?: string;
+    title?: string;
+    viewsCount?: number;
+};

package/dist/streams-api-client-model.d.ts

@@ -0,0 +1,5 @@
+export type StreamsApiClientModel = {
+    streamsGqlEndpoint: string;
+    organizationId: string;
+    siteId: string;
+};

package/dist/streams-content-api-client.d.ts

@@ -0,0 +1,14 @@
+import type { AdCampaign, Article, ContentList, Post } from './types';
+export declare class StreamsContentApiClient {
+    private readonly gqlEndpoint;
+    private readonly organizationId;
+    private readonly siteId;
+    private readonly postStatus;
+    constructor(gqlEndpoint: string, organizationId: string, siteId: string);
+    getArticle(slug: string): Promise<Article | null>;
+    getPost(id: string): Promise<Post | undefined>;
+    getPosts(ids: string[] | null, types?: string[] | null, contentListId?: string | null): Promise<Post[] | undefined>;
+    getContentLists(): Promise<ContentList[] | undefined>;
+    getAdCampaigns(page: number, perPage: number): Promise<AdCampaign[] | undefined>;
+    private queryGql;
+}

package/dist/streams-content-api-client.js

@@ -0,0 +1,89 @@
+import SiteActiveCampaignsQuery from './adcampaignsquery.graphql.js';
+import SiteArticleQuery from './articlequery.graphql.js';
+import SiteContentListsQuery from './contentlistsquery.graphql.js';
+import SitePostsQuery from './postsquery.graphql.js';
+import { SitePostsOrderBy, SiteContentListsOrderBy, SiteAdCampaignsOrderBy } from './types.js';
+
+class StreamsContentApiClient {
+    gqlEndpoint = '{{streamsGqlEndpoint}}';
+    organizationId = '{{organizationId}}';
+    siteId = '{{siteId}}';
+    postStatus = 'PUBLISHED';
+    constructor(gqlEndpoint, organizationId, siteId) {
+        this.gqlEndpoint = gqlEndpoint;
+        this.organizationId = organizationId;
+        this.siteId = siteId;
+    }
+    async getArticle(slug) {
+        const response = await this.queryGql(SiteArticleQuery, { organizationId: this.organizationId, slug });
+        return response.siteArticle;
+    }
+    async getPost(id) {
+        const response = await this.getPosts([id]);
+        return response?.pop();
+    }
+    async getPosts(ids, types = null, contentListId = null) {
+        const response = await this.queryGql(SitePostsQuery, {
+            cursor: {
+                sorting: {
+                    orderBy: SitePostsOrderBy.Published
+                }
+            },
+            filter: {
+                ids: ids,
+                organizationId: this.organizationId,
+                postTypes: types,
+                statuses: [this.postStatus],
+                contentListId: contentListId
+            }
+        });
+        return response.sitePosts?.items;
+    }
+    async getContentLists() {
+        const response = await this.queryGql(SiteContentListsQuery, {
+            cursor: {
+                sorting: {
+                    orderBy: SiteContentListsOrderBy.Name
+                }
+            },
+            filter: {
+                organizationId: this.organizationId
+            }
+        });
+        return response.siteContentLists?.items;
+    }
+    async getAdCampaigns(page, perPage) {
+        const response = await this.queryGql(SiteActiveCampaignsQuery, {
+            pageQuery: {
+                orderBy: SiteAdCampaignsOrderBy.Modified,
+                fetchTotal: false,
+                page: page,
+                perPage: perPage
+            },
+            filter: {
+                organizationId: this.organizationId,
+                siteId: this.siteId
+            }
+        });
+        return response.siteActiveCampaigns?.items;
+    }
+    queryGql = async (query, variables) => {
+        const response = await fetch(this.gqlEndpoint, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({
+                query,
+                variables
+            })
+        });
+        const gql = await response.json();
+        if (!gql.data) {
+            throw new Error(JSON.stringify(gql.errors));
+        }
+        return gql.data;
+    };
+}
+
+export { StreamsContentApiClient };