@streamscloud/streams-api-client 1.0.0 → 2.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-content-api-client.js

@@ -1,9 +1,10 @@
-import SiteActiveCampaignsQuery from './adcampaignsquery.graphql';
-import SiteArticleQuery from './articlequery.graphql';
-import SiteContentListsQuery from './contentlistsquery.graphql';
-import SitePostsQuery from './postsquery.graphql';
-import { SiteAdCampaignsOrderBy, SiteContentListsOrderBy, SitePostsOrderBy } from './types';
-export class StreamsContentApiClient {
+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}}';
@@ -84,4 +85,5 @@ export class StreamsContentApiClient {
         return gql.data;
     };
 }
-//# sourceMappingURL=streams-content-api-client.js.map
+
+export { StreamsContentApiClient };

package/dist/types.d.ts

@@ -200,7 +200,7 @@ export type ContentMediaItem = IMediaItem & {
     metadata: MediaItemMetadata;
     productTags?: ProductTagPosition[];
     thumbnailBlobId?: string;
-    thumbnailUrl?: string;
+    thumbnailUrl: string | null;
     type: MediaType;
     url: string;
     userTags?: UserTagPosition[];
@@ -429,7 +429,7 @@ export type PostData = {
     audioData?: AudioPostData;
     eventData?: EventPostData;
     linkData?: LinkPostData;
-    media?: ContentMediaItem[];
+    media: ContentMediaItem[];
     mediaData?: MediaPostData;
     momentData?: MomentPostData;
     postType: PostType;
@@ -439,7 +439,7 @@ export type PostData = {
 };
 export type PostHeading = {
     networkData?: PostHeadingNetworkTargetData;
-    postDisplayDate: Date;
+    postDisplayDate: string;
     postViewsCount: number;
     sourceHandle: string;
     sourceId: string;

package/dist/types.js

@@ -1,27 +1,27 @@
-export var AdType;
+var AdType;
 (function (AdType) {
     AdType["BannerResponsive"] = "BANNER_RESPONSIVE";
     AdType["MediaDialogPromotion"] = "MEDIA_DIALOG_PROMOTION";
     AdType["Story"] = "STORY";
 })(AdType || (AdType = {}));
-export var AdPricingPlan;
+var AdPricingPlan;
 (function (AdPricingPlan) {
     AdPricingPlan["Free"] = "FREE";
     AdPricingPlan["Paid"] = "PAID";
 })(AdPricingPlan || (AdPricingPlan = {}));
-export var AdStatus;
+var AdStatus;
 (function (AdStatus) {
     AdStatus["Archived"] = "ARCHIVED";
     AdStatus["Draft"] = "DRAFT";
     AdStatus["Published"] = "PUBLISHED";
 })(AdStatus || (AdStatus = {}));
-export var SiteAdCampaignsOrderBy;
+var SiteAdCampaignsOrderBy;
 (function (SiteAdCampaignsOrderBy) {
     SiteAdCampaignsOrderBy["Created"] = "CREATED";
     SiteAdCampaignsOrderBy["Modified"] = "MODIFIED";
     SiteAdCampaignsOrderBy["Name"] = "NAME";
 })(SiteAdCampaignsOrderBy || (SiteAdCampaignsOrderBy = {}));
-export var ArticleFieldType;
+var ArticleFieldType;
 (function (ArticleFieldType) {
     ArticleFieldType["Byline"] = "BYLINE";
     ArticleFieldType["Image"] = "IMAGE";
@@ -31,55 +31,55 @@ export var ArticleFieldType;
     ArticleFieldType["Text"] = "TEXT";
     ArticleFieldType["Video"] = "VIDEO";
 })(ArticleFieldType || (ArticleFieldType = {}));
-export var ArticleLayoutType;
+var ArticleLayoutType;
 (function (ArticleLayoutType) {
     ArticleLayoutType["Vertical"] = "VERTICAL";
 })(ArticleLayoutType || (ArticleLayoutType = {}));
-export var Currency;
+var Currency;
 (function (Currency) {
     Currency["Eur"] = "EUR";
     Currency["Nok"] = "NOK";
     Currency["Usd"] = "USD";
 })(Currency || (Currency = {}));
-export var DisplayVariant;
+var DisplayVariant;
 (function (DisplayVariant) {
     DisplayVariant["Variant1"] = "VARIANT1";
 })(DisplayVariant || (DisplayVariant = {}));
-export var GalleryFieldMode;
+var GalleryFieldMode;
 (function (GalleryFieldMode) {
     GalleryFieldMode["Gallery"] = "GALLERY";
     GalleryFieldMode["Slider"] = "SLIDER";
 })(GalleryFieldMode || (GalleryFieldMode = {}));
-export var ImageScale;
+var ImageScale;
 (function (ImageScale) {
     ImageScale["Big"] = "BIG";
     ImageScale["Medium"] = "MEDIUM";
     ImageScale["OriginalEncoded"] = "ORIGINAL_ENCODED";
     ImageScale["Small"] = "SMALL";
 })(ImageScale || (ImageScale = {}));
-export var LayoutMode;
+var LayoutMode;
 (function (LayoutMode) {
     LayoutMode["Horizontal"] = "HORIZONTAL";
     LayoutMode["Standard"] = "STANDARD";
 })(LayoutMode || (LayoutMode = {}));
-export var MediaFormat;
+var MediaFormat;
 (function (MediaFormat) {
     MediaFormat["W4H3"] = "W4H3";
     MediaFormat["W16H9"] = "W16H9";
 })(MediaFormat || (MediaFormat = {}));
-export var MediaType;
+var MediaType;
 (function (MediaType) {
     MediaType["Audio"] = "AUDIO";
     MediaType["Image"] = "IMAGE";
     MediaType["ShortVideo"] = "SHORT_VIDEO";
     MediaType["Video"] = "VIDEO";
 })(MediaType || (MediaType = {}));
-export var MomentLifetime;
+var MomentLifetime;
 (function (MomentLifetime) {
     MomentLifetime["Day"] = "DAY";
     MomentLifetime["Week"] = "WEEK";
 })(MomentLifetime || (MomentLifetime = {}));
-export var PostCategory;
+var PostCategory;
 (function (PostCategory) {
     PostCategory["Education"] = "EDUCATION";
     PostCategory["Entertainment"] = "ENTERTAINMENT";
@@ -88,7 +88,7 @@ export var PostCategory;
     PostCategory["Shopping"] = "SHOPPING";
     PostCategory["Sports"] = "SPORTS";
 })(PostCategory || (PostCategory = {}));
-export var PostSourceType;
+var PostSourceType;
 (function (PostSourceType) {
     PostSourceType["Channel"] = "CHANNEL";
     PostSourceType["Group"] = "GROUP";
@@ -96,7 +96,7 @@ export var PostSourceType;
     PostSourceType["Organization"] = "ORGANIZATION";
     PostSourceType["UserProfile"] = "USER_PROFILE";
 })(PostSourceType || (PostSourceType = {}));
-export var PostType;
+var PostType;
 (function (PostType) {
     PostType["Article"] = "ARTICLE";
     PostType["Audio"] = "AUDIO";
@@ -108,12 +108,12 @@ export var PostType;
     PostType["Text"] = "TEXT";
     PostType["Video"] = "VIDEO";
 })(PostType || (PostType = {}));
-export var PostedAs;
+var PostedAs;
 (function (PostedAs) {
     PostedAs["AuthorProfile"] = "AUTHOR_PROFILE";
     PostedAs["OwnerProfile"] = "OWNER_PROFILE";
 })(PostedAs || (PostedAs = {}));
-export var PricingMeasureUnit;
+var PricingMeasureUnit;
 (function (PricingMeasureUnit) {
     PricingMeasureUnit["Other"] = "OTHER";
     PricingMeasureUnit["PerBag"] = "PER_BAG";
@@ -147,75 +147,76 @@ export var PricingMeasureUnit;
     PricingMeasureUnit["PerUnit"] = "PER_UNIT";
     PricingMeasureUnit["PerYard"] = "PER_YARD";
 })(PricingMeasureUnit || (PricingMeasureUnit = {}));
-export var ProductAnnotationPosition;
+var ProductAnnotationPosition;
 (function (ProductAnnotationPosition) {
     ProductAnnotationPosition["BottomLeft"] = "BOTTOM_LEFT";
     ProductAnnotationPosition["BottomRight"] = "BOTTOM_RIGHT";
     ProductAnnotationPosition["TopLeft"] = "TOP_LEFT";
     ProductAnnotationPosition["TopRight"] = "TOP_RIGHT";
 })(ProductAnnotationPosition || (ProductAnnotationPosition = {}));
-export var ProductAnnotationType;
+var ProductAnnotationType;
 (function (ProductAnnotationType) {
     ProductAnnotationType["Svg"] = "SVG";
 })(ProductAnnotationType || (ProductAnnotationType = {}));
-export var ProductAvailability;
+var ProductAvailability;
 (function (ProductAvailability) {
     ProductAvailability["Backorder"] = "BACKORDER";
     ProductAvailability["InStock"] = "IN_STOCK";
     ProductAvailability["OutOfStock"] = "OUT_OF_STOCK";
     ProductAvailability["Preorder"] = "PREORDER";
 })(ProductAvailability || (ProductAvailability = {}));
-export var ProductStatus;
+var ProductStatus;
 (function (ProductStatus) {
     ProductStatus["Archived"] = "ARCHIVED";
     ProductStatus["Draft"] = "DRAFT";
     ProductStatus["Published"] = "PUBLISHED";
 })(ProductStatus || (ProductStatus = {}));
-export var ProfileType;
+var ProfileType;
 (function (ProfileType) {
     ProfileType["Channel"] = "CHANNEL";
     ProfileType["Group"] = "GROUP";
     ProfileType["Organization"] = "ORGANIZATION";
     ProfileType["User"] = "USER";
 })(ProfileType || (ProfileType = {}));
-export var PublishTargetType;
+var PublishTargetType;
 (function (PublishTargetType) {
     PublishTargetType["Channel"] = "CHANNEL";
     PublishTargetType["Group"] = "GROUP";
     PublishTargetType["MediaPage"] = "MEDIA_PAGE";
     PublishTargetType["User"] = "USER";
 })(PublishTargetType || (PublishTargetType = {}));
-export var ReactableType;
+var ReactableType;
 (function (ReactableType) {
     ReactableType["ChatMessage"] = "CHAT_MESSAGE";
     ReactableType["Comment"] = "COMMENT";
     ReactableType["CommunityMessage"] = "COMMUNITY_MESSAGE";
     ReactableType["Post"] = "POST";
 })(ReactableType || (ReactableType = {}));
-export var SitePostsOrderBy;
+var SitePostsOrderBy;
 (function (SitePostsOrderBy) {
     SitePostsOrderBy["Published"] = "PUBLISHED";
 })(SitePostsOrderBy || (SitePostsOrderBy = {}));
-export var Status;
+var Status;
 (function (Status) {
     Status["Archived"] = "ARCHIVED";
     Status["Draft"] = "DRAFT";
     Status["Published"] = "PUBLISHED";
     Status["Scheduled"] = "SCHEDULED";
 })(Status || (Status = {}));
-export var TextFieldMode;
+var TextFieldMode;
 (function (TextFieldMode) {
     TextFieldMode["Multiline"] = "MULTILINE";
     TextFieldMode["SingleLine"] = "SINGLE_LINE";
 })(TextFieldMode || (TextFieldMode = {}));
-export var TextFieldWeight;
+var TextFieldWeight;
 (function (TextFieldWeight) {
     TextFieldWeight["Bold"] = "BOLD";
     TextFieldWeight["Normal"] = "NORMAL";
     TextFieldWeight["SemiBold"] = "SEMI_BOLD";
 })(TextFieldWeight || (TextFieldWeight = {}));
-export var SiteContentListsOrderBy;
+var SiteContentListsOrderBy;
 (function (SiteContentListsOrderBy) {
     SiteContentListsOrderBy["Name"] = "NAME";
 })(SiteContentListsOrderBy || (SiteContentListsOrderBy = {}));
-//# sourceMappingURL=types.js.map
+
+export { AdPricingPlan, AdStatus, AdType, ArticleFieldType, ArticleLayoutType, Currency, DisplayVariant, GalleryFieldMode, ImageScale, LayoutMode, MediaFormat, MediaType, MomentLifetime, PostCategory, PostSourceType, PostType, PostedAs, PricingMeasureUnit, ProductAnnotationPosition, ProductAnnotationType, ProductAvailability, ProductStatus, ProfileType, PublishTargetType, ReactableType, SiteAdCampaignsOrderBy, SiteContentListsOrderBy, SitePostsOrderBy, Status, TextFieldMode, TextFieldWeight };

package/package.json

@@ -1,9 +1,29 @@
 {
   "name": "@streamscloud/streams-api-client",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "type": "module",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts",
+      "svelte": "./dist/index.js"
+    },
+    "./data-loaders": {
+      "import": "./dist/data-loaders/index.js",
+      "types": "./dist/data-loaders/index.d.ts"
+    },
+    "./components-data": {
+      "import": "./dist/components-data/index.js",
+      "types": "./dist/components-data/index.d.ts"
+    },
+    "./services": {
+      "import": "./dist/services/index.js",
+      "types": "./dist/services/index.d.ts"
+    }
+  },
   "files": [
     "dist"
   ],

package/dist/adcampaignsquery.graphql

@@ -1,42 +0,0 @@
-query SiteActiveCampaigns($filter: SiteActiveCampaignsFilterInput!, $pageQuery: PaginationOfAdCampaignsOrderByInput!) {
-  siteActiveCampaigns(filter: $filter, pagination: $pageQuery) {
-    total
-    items {
-      id
-      name
-      status
-      adGroupIds
-      adGroups {
-        name
-        ads {
-          ..._adForGridPayloadFragment
-        }
-        adPlacement {
-          name
-        }
-      }
-      status
-      updatedAt
-      editorProfile {
-        id
-        name
-        handle
-        image
-      }
-    }
-  }
-}
-
-fragment _adForGridPayloadFragment on Ad {
-  id
-  media {
-    type
-    url
-    thumbnailUrl
-  }
-  name
-  title
-  description
-  status
-  updatedAt
-}