@prezly/sdk 10.1.0-0 → 10.2.0

package/dist/api/constants.js

@@ -1,3 +1,3 @@
-const VERSION = "10.0.0";
+const VERSION = "10.1.0-0";
 const URL = 'https://github.com/prezly/javascript-sdk';
 export const DEFAULT_USER_AGENT = `prezly-javascript-sdk/${VERSION} (+${URL})`;

package/dist/endpoints/Stories/Client.d.ts

@@ -1,6 +1,6 @@
 import type { DeferredJobsApiClient } from '../../api';
 import type { ExtendedStory, Story } from '../../types';
-import type { ListOptions, ListResponse, SearchOptions, CreateRequest, UpdateRequest } from './types';
+import type { AutosaveRequest, CreateRequest, IncludeOptions, ListOptions, ListResponse, PublishRequest, RevertRequest, ScheduleRequest, SearchOptions, UnpublishRequest, UnscheduleRequest, UpdateRequest } from './types';
 /**
  * `uuid` is the preferred way of targeting a Story. Numeric `id` is considered deprecated.
  */
@@ -9,9 +9,39 @@ export declare class Client {
     private readonly apiClient;
     constructor(apiClient: DeferredJobsApiClient);
     list<Include extends readonly (keyof Story.ExtraFields)[], Options extends ListOptions<Include>, StoryRecord extends Story = Options['include'] extends Include ? Story & Pick<Story.ExtraFields, Options['include'][number]> : Story>(options?: Options): Promise<ListResponse<StoryRecord>>;
-    search<Include extends readonly (keyof Story.ExtraFields)[], Options extends ListOptions<Include>, StoryRecord extends Story = Options['include'] extends Include ? Story & Pick<Story.ExtraFields, Options['include'][number]> : Story>(options: SearchOptions<Include>): Promise<ListResponse<StoryRecord>>;
-    get(id: StoryId): Promise<ExtendedStory>;
-    create(payload: CreateRequest): Promise<ExtendedStory>;
-    update(id: StoryId, payload: UpdateRequest): Promise<ExtendedStory>;
+    search<Include extends readonly (keyof Story.ExtraFields)[], Options extends SearchOptions<Include>, StoryRecord extends Story = Options['include'] extends Include ? Story & Pick<Story.ExtraFields, Options['include'][number]> : Story>(options?: Options): Promise<ListResponse<StoryRecord>>;
+    /**
+     * Get story by UUID.
+     */
+    get<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: Story['uuid'], options?: Options): Promise<StoryRecord>;
+    /**
+     * Get multiple stories by UUIDs.
+     */
+    get<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(ids: Story['uuid'][], options?: Options): Promise<StoryRecord[]>;
+    /**
+     * Get story by deprecated numeric ID, or UUID.
+     * @deprecated Please use UUID instead.
+     */
+    get<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: Story['id'] | Story['uuid'], options?: Options): Promise<StoryRecord>;
+    /**
+     * Get multiple stories by numeric IDs.
+     * @deprecated Please use UUID instead.
+     */
+    get<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(ids: Story['id'][], options?: Options): Promise<StoryRecord[]>;
+    create<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(payload: CreateRequest, options?: Options): Promise<StoryRecord>;
+    update<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload: UpdateRequest, options?: Options): Promise<StoryRecord>;
+    /**
+     * This operation is only allowed for V3 stories
+     */
+    autosave<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload: AutosaveRequest, options?: Options): Promise<StoryRecord>;
+    /**
+     * This operation is only allowed for V3 stories
+     */
+    revert<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload?: RevertRequest, options?: Options): Promise<StoryRecord>;
+    publish<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload?: PublishRequest, options?: Options): Promise<StoryRecord>;
+    unpublish<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload?: UnpublishRequest, options?: Options): Promise<StoryRecord>;
+    schedule<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload?: ScheduleRequest, options?: Options): Promise<StoryRecord>;
+    unschedule<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload?: UnscheduleRequest, options?: Options): Promise<StoryRecord>;
+    delete(id: StoryId): Promise<void>;
 }
 export {};

package/dist/endpoints/Stories/Client.js

@@ -37,27 +37,171 @@ export class Client {
       }
     });
   }
-  async get(id) {
+
+  /**
+   * Get story by UUID.
+   */
+
+  /**
+   * Implementation
+   */
+  async get(arg, options) {
+    const include = options?.include;
+    const isArray = Array.isArray(arg);
+    if (isArray && arg.length === 0) {
+      // No need to call the API.
+      return [];
+    }
+    if (isArray && typeof arg[0] === 'number') {
+      const {
+        stories
+      } = await this.search({
+        limit: arg.length,
+        query: {
+          id: {
+            $in: arg
+          }
+        },
+        include
+      });
+      return stories;
+    }
+    if (isArray && typeof arg[0] === 'string') {
+      const {
+        stories
+      } = await this.search({
+        limit: arg.length,
+        query: {
+          uuid: {
+            $in: arg
+          }
+        },
+        include
+      });
+      return stories;
+    }
     const {
       story
-    } = await this.apiClient.get(`${routing.storiesUrl}/${id}`);
+    } = await this.apiClient.get(`${routing.storiesUrl}/${arg}`, {
+      query: {
+        include: include
+      }
+    });
     return story;
   }
-  async create(payload) {
+  async create(payload, options) {
+    const include = options?.include;
     const {
       story
     } = await this.apiClient.post(routing.storiesUrl, {
-      payload
+      payload,
+      query: {
+        include: include
+      }
     });
     return story;
   }
-  async update(id, payload) {
+  async update(id, payload, options) {
     const url = `${routing.storiesUrl}/${id}`;
+    const include = options?.include;
+    const {
+      story
+    } = await this.apiClient.patch(url, {
+      payload,
+      query: {
+        include: include
+      }
+    });
+    return story;
+  }
+
+  /**
+   * This operation is only allowed for V3 stories
+   */
+  async autosave(id, payload, options) {
+    const url = `${routing.storiesUrl}/${id}/autosave`;
+    const include = options?.include;
     const {
       story
     } = await this.apiClient.patch(url, {
-      payload
+      payload,
+      query: {
+        include: include
+      }
+    });
+    return story;
+  }
+
+  /**
+   * This operation is only allowed for V3 stories
+   */
+  async revert(id, payload, options) {
+    const url = `${routing.storiesUrl}/${id}/revert`;
+    const include = options?.include;
+    const {
+      story
+    } = await this.apiClient.post(url, {
+      payload,
+      query: {
+        include: include
+      }
+    });
+    return story;
+  }
+  async publish(id, payload, options) {
+    const url = `${routing.storiesUrl}/${id}/publish`;
+    const include = options?.include;
+    const {
+      story
+    } = await this.apiClient.post(url, {
+      payload,
+      query: {
+        include: include
+      }
+    });
+    return story;
+  }
+  async unpublish(id, payload, options) {
+    const url = `${routing.storiesUrl}/${id}/unpublish`;
+    const include = options?.include;
+    const {
+      story
+    } = await this.apiClient.post(url, {
+      payload,
+      query: {
+        include: include
+      }
+    });
+    return story;
+  }
+  async schedule(id, payload, options) {
+    const url = `${routing.storiesUrl}/${id}/schedule`;
+    const include = options?.include;
+    const {
+      story
+    } = await this.apiClient.post(url, {
+      payload,
+      query: {
+        include: include
+      }
     });
     return story;
   }
+  async unschedule(id, payload, options) {
+    const url = `${routing.storiesUrl}/${id}/unpublish`;
+    const include = options?.include;
+    const {
+      story
+    } = await this.apiClient.post(url, {
+      payload,
+      query: {
+        include: include
+      }
+    });
+    return story;
+  }
+  async delete(id) {
+    const url = `${routing.storiesUrl}/${id}`;
+    await this.apiClient.delete(url);
+  }
 }

package/dist/endpoints/Stories/index.d.ts

@@ -1,2 +1,3 @@
 export * from './Client';
 export * from './types';
+export * from './scopes';

package/dist/endpoints/Stories/index.js

@@ -1,2 +1,3 @@
 export * from "./Client.js";
-export * from "./types.js";
+export * from "./types.js";
+export * from "./scopes.js";

package/dist/endpoints/Stories/scopes.d.ts

@@ -0,0 +1,2 @@
+import type { Query } from '../../types';
+export declare const Scope: Record<string, Query>;

package/dist/endpoints/Stories/scopes.js

@@ -0,0 +1,8 @@
+import { Newsroom } from "../../types/index.js";
+export const Scope = {
+  EXCLUDE_ARCHIVED_NEWSROOMS: {
+    'newsroom.status': {
+      $nin: [Newsroom.Status.ARCHIVED]
+    }
+  }
+};

package/dist/endpoints/Stories/types.d.ts

@@ -1,4 +1,4 @@
-import type { Category, CultureRef, NewsroomRef, Pagination, Query, Story } from '../../types';
+import type { Category, CultureRef, Newsroom, Pagination, Query, Story } from '../../types';
 /**
  * Uploadcare image JSON string.
  */
@@ -12,6 +12,9 @@ declare type Html = string;
  * String containing Prezly Content Format JSON structure.
  */
 declare type PrezlyContentFormat = string;
+export interface IncludeOptions<Include extends readonly (keyof Story.ExtraFields)[]> {
+    include?: Include;
+}
 export interface ListOptions<Include extends readonly (keyof Story.ExtraFields)[]> {
     limit?: number;
     offset?: number;
@@ -20,6 +23,7 @@ export interface ListOptions<Include extends readonly (keyof Story.ExtraFields)[
 }
 export interface SearchOptions<Include extends readonly (keyof Story.ExtraFields)[]> extends ListOptions<Include> {
     query?: Query;
+    scope?: Query;
 }
 export interface ListResponse<S extends Story = Story> {
     stories: S[];
@@ -27,18 +31,19 @@ export interface ListResponse<S extends Story = Story> {
     sort: string;
 }
 interface GenericCreateRequest {
-    newsroom?: NewsroomRef['id'];
+    newsroom?: Newsroom['id'] | Newsroom['uuid'];
     title?: string;
     subtitle?: string;
     published_at?: Iso8601DateTime;
     visibility?: Story.Visibility;
     culture?: CultureRef['code'];
-    header_image?: UploadedImage;
-    preview_image?: UploadedImage;
-    social_image?: UploadedImage;
+    header_image?: UploadedImage | null;
+    preview_image?: UploadedImage | null;
+    social_image?: UploadedImage | null;
     social_text?: string;
     categories?: Category['id'][];
     tags?: string[];
+    is_shared_to_prpro?: boolean;
 }
 interface GenericUpdateRequest {
     title?: string;
@@ -46,20 +51,21 @@ interface GenericUpdateRequest {
     published_at?: Iso8601DateTime;
     visibility?: Story.Visibility;
     culture?: CultureRef['code'];
-    header_image?: UploadedImage;
-    preview_image?: UploadedImage;
-    social_image?: UploadedImage;
+    header_image?: UploadedImage | null;
+    preview_image?: UploadedImage | null;
+    social_image?: UploadedImage | null;
     social_text?: string;
     categories?: Category['id'][];
     tags?: string[];
+    is_shared_to_prpro?: boolean;
 }
 export interface HtmlStoryCreateRequest extends GenericCreateRequest {
     /**
      * If format version is omitted, license default editor version will be implied.
      */
     format_version?: Story.FormatVersion.HTML;
-    intro: Html;
-    content: Html;
+    intro?: Html;
+    content?: Html;
     /**
      * Attached gallery slate content.
      */
@@ -73,12 +79,12 @@ export interface SlateStoryCreateRequest extends GenericCreateRequest {
     /**
      * Intro field is not supported for Prezly Content Format stories.
      */
-    intro: never;
-    content: PrezlyContentFormat;
+    intro?: never;
+    content?: PrezlyContentFormat;
 }
 export interface HtmlStoryUpdateRequest extends GenericUpdateRequest {
-    intro: Html;
-    content: Html;
+    intro?: Html;
+    content?: Html;
     /**
      * Attached gallery slate content.
      */
@@ -88,9 +94,32 @@ export interface SlateStoryUpdateRequest extends GenericUpdateRequest {
     /**
      * Intro field is not supported for Prezly Content Format stories.
      */
-    intro: never;
-    content: PrezlyContentFormat;
+    intro?: never;
+    content?: PrezlyContentFormat;
+    autosaved_content?: PrezlyContentFormat;
+    content_version?: number;
 }
 export declare type CreateRequest = HtmlStoryCreateRequest | SlateStoryCreateRequest;
 export declare type UpdateRequest = HtmlStoryUpdateRequest | SlateStoryUpdateRequest;
+export interface AutosaveRequest {
+    autosaved_content: PrezlyContentFormat;
+    content_version?: number;
+}
+export interface RevertRequest {
+    content_version?: number;
+}
+export interface PublishRequest {
+    published_at?: Iso8601DateTime;
+    visibility?: Story.Visibility.PUBLIC | Story.Visibility.PRIVATE | Story.Visibility.CONFIDENTIAL;
+}
+export interface UnpublishRequest {
+    visibility?: Story.Visibility.PUBLIC | Story.Visibility.PRIVATE | Story.Visibility.CONFIDENTIAL;
+}
+export interface ScheduleRequest {
+    publish_at?: Iso8601DateTime;
+    visibility?: Story.Visibility.PUBLIC | Story.Visibility.EMBARGO;
+}
+export declare type UnscheduleRequest = UnpublishRequest;
+export declare const ALL_EXTRA_FIELDS: (keyof Story.ExtraFields)[];
+export declare const EXTENDED_STORY_INCLUDED_EXTRA_FIELDS: ("content" | "thumbnail_image" | "header_image" | "preview_image" | "social_image" | "social_text" | "tag_names" | "attached_gallery_content" | "referenced_entities")[];
 export {};

package/dist/endpoints/Stories/types.js

@@ -1 +1,43 @@
-export {};
+/**
+ * Uploadcare image JSON string.
+ */
+
+/**
+ * Raw HTML string.
+ */
+
+/**
+ * String containing Prezly Content Format JSON structure.
+ */
+
+const EXTENDED_STORY_INCLUDED_EXTRA_FIELDS_SHAPE = {
+  thumbnail_image: true,
+  header_image: true,
+  preview_image: true,
+  social_image: true,
+  social_text: true,
+  tag_names: true,
+  content: true,
+  attached_gallery_content: true,
+  referenced_entities: true
+}; // satisfies Record<keyof Omit<ExtendedStory, keyof Story>, boolean>; // TODO: Use Typescript `satisfies` operator, when it's out of beta
+
+const ALL_EXTRA_FIELDS_SHAPE = {
+  thumbnail_image: true,
+  header_image: true,
+  preview_image: true,
+  social_image: true,
+  social_text: true,
+  tag_names: true,
+  content: true,
+  autosaved_content: true,
+  content_version: true,
+  last_modifying_user: true,
+  attached_gallery_content: true,
+  referenced_entities: true,
+  'campaigns.count': true,
+  'pitches.count': true
+}; // satisfies Record<keyof Story.OnDemandFields, boolean>; // TODO: Use Typescript `satisfies` operator, when it's out of beta
+
+export const ALL_EXTRA_FIELDS = Object.keys(ALL_EXTRA_FIELDS_SHAPE);
+export const EXTENDED_STORY_INCLUDED_EXTRA_FIELDS = Object.keys(EXTENDED_STORY_INCLUDED_EXTRA_FIELDS_SHAPE);

package/dist/types/Story.d.ts

@@ -12,6 +12,11 @@ export interface StoryRef {
     id: number;
     title: string;
     slug: string;
+    /**
+     * @deprecated Please use `lifecycle_status` instead.
+     * @see lifecycle_status
+     * @see Story.LifecycleStatus
+     */
     publication_status: Story.PublicationStatus;
     lifecycle_status: Story.LifecycleStatus;
     visibility: Story.Visibility;
@@ -73,22 +78,58 @@ export interface Story {
     published_at: string | null;
     scheduled_at: string | null;
     lifecycle_status: Story.LifecycleStatus;
+    /**
+     * @deprecated Please use `newsroom.status` instead.
+     * @see newsroom
+     * @see Newsroom.Status
+     */
     is_archived: boolean;
+    /**
+     * @deprecated Please use `lifecycle_status` instead.
+     * @see lifecycle_status
+     * @see Story.LifecycleStatus
+     */
     is_finalized: boolean;
+    /**
+     * @deprecated Please use `lifecycle_status` instead.
+     * @see lifecycle_status
+     * @see Story.LifecycleStatus
+     */
     is_published: boolean;
+    /**
+     * @deprecated Please use `lifecycle_status` instead.
+     * @see lifecycle_status
+     * @see Story.LifecycleStatus
+     */
     is_draft: boolean;
+    /**
+     * @deprecated Please use `lifecycle_status` instead.
+     * @see lifecycle_status
+     * @see Story.LifecycleStatus
+     */
     is_embargo: boolean;
+    /**
+     * @deprecated Please use `visibility` instead.
+     * @see visibility
+     * @see Story.Visibility
+     */
     is_private: boolean;
+    /**
+     * @deprecated Please use `lifecycle_status` instead.
+     * @see lifecycle_status
+     * @see Story.LifecycleStatus
+     */
     is_scheduled: boolean;
     is_sharable: boolean;
     is_analytics_available: boolean;
-    publication_status: Story.PublicationStatus;
-    visibility: Story.Visibility;
+    is_shared_to_prpro: boolean;
     /**
-     * Contains attached gallery slate content.
-     * Always `null` for v3 stories.
+     * @deprecated Please use `lifecycle_status` instead.
+     * @see lifecycle_status
+     * @see Story.LifecycleStatus
      */
-    attached_gallery_content: string | null;
+    publication_status: Story.PublicationStatus;
+    visibility: Story.Visibility;
 }
 export declare namespace Story {
     enum FormatVersion {
@@ -102,6 +143,10 @@ export declare namespace Story {
         EMBARGO = "embargo",
         PUBLISHED = "published"
     }
+    /**
+     * Please use `LifecycleStatus` instead.
+     * @see LifecycleStatus
+     */
     enum PublicationStatus {
         NEW = "new",
         DRAFT = "draft",
@@ -114,12 +159,6 @@ export declare namespace Story {
         CONFIDENTIAL = "confidential"
     }
     interface ExtraFields {
-        /**
-         * Depending on `format_version` this field can contain:
-         * - HTML content for v1 stories (deprecated)
-         * - JSON-encoded structured content for v3 stories (see Prezly Content Format).
-         */
-        content: string;
         /**
          * Uploadcare image JSON.
          */
@@ -138,9 +177,41 @@ export declare namespace Story {
         social_image: string | null;
         social_text: string;
         tag_names: string[];
+        /**
+         * Depending on `format_version` this field can contain:
+         * - HTML content for v1 stories (deprecated)
+         * - JSON-encoded structured content for v3 stories (see Prezly Content Format).
+         */
+        content: string;
+        /**
+         * Only supported on v3 stories with JSON-encoded structured content.
+         */
+        autosaved_content: string | null;
+        /**
+         * Auto-incrementing version number updated on every update.
+         * Used for detecting multiple users editing the same story simultaneously.
+         */
+        content_version: number;
+        /**
+         * User who performed the latest update on the story.
+         */
+        last_modifying_user: UserRef | null;
+        /**
+         * Contains attached gallery slate content.
+         * Always `null` for v3 stories.
+         */
+        attached_gallery_content: string | null;
         referenced_entities: {
             stories: Record<string, OEmbedInfo>;
         };
+        /**
+         * Number of campaigns linked to this story.
+         */
+        'campaigns.count': number;
+        /**
+         * Number of pitches linked to this story.
+         */
+        'pitches.count': number;
     }
     function isUninitialized(status: LifecycleStatus): boolean;
     function isUninitialized(story: Pick<Story, 'lifecycle_status'>): boolean;
@@ -153,5 +224,5 @@ export declare namespace Story {
     function isPublished(status: LifecycleStatus): boolean;
     function isPublished(story: Pick<Story, 'lifecycle_status'>): boolean;
 }
-export interface ExtendedStory extends Story, Story.ExtraFields {
+export interface ExtendedStory extends Story, Pick<Story.ExtraFields, 'thumbnail_image' | 'header_image' | 'preview_image' | 'social_image' | 'social_text' | 'tag_names' | 'content' | 'attached_gallery_content' | 'referenced_entities'> {
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@prezly/sdk",
-    "version": "10.1.0-0",
+    "version": "10.2.0",
     "description": "Prezly API SDK",
     "type": "module",
     "main": "dist/index.js",