@prezly/sdk 12.5.0 → 12.6.0

package/dist/api/constants.cjs

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.DEFAULT_USER_AGENT = void 0;
-const VERSION = "12.4.2";
+const VERSION = "12.5.0";
 const URL = 'https://github.com/prezly/javascript-sdk';
 const DEFAULT_USER_AGENT = `prezly-javascript-sdk/${VERSION} (+${URL})`;
 exports.DEFAULT_USER_AGENT = DEFAULT_USER_AGENT;

package/dist/api/constants.js

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

package/dist/endpoints/Stories/Client.cjs

@@ -121,7 +121,10 @@ class Client {
     });
     return story;
   }
-  async translate(id, payload, options) {
+  async translate(id, payload = {}, options) {
+    const {
+      culture
+    } = payload ?? {};
     const include = options?.include;
     const url = `${_routing.routing.storiesUrl}/${id}/translate`;
     const {
@@ -130,7 +133,9 @@ class Client {
       query: {
         include: include
       },
-      payload
+      payload: {
+        culture
+      }
     });
     return story;
   }

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

@@ -35,7 +35,7 @@ export declare class Client {
     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?: Exactly<IncludeOptions<Include>, 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?: Exactly<IncludeOptions<Include>, Options>): Promise<StoryRecord>;
     duplicate<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, options?: Exactly<IncludeOptions<Include>, Options>): Promise<StoryRecord>;
-    translate<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: TranslateRequest, options?: Exactly<IncludeOptions<Include>, Options>): Promise<StoryRecord>;
+    translate<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?: TranslateRequest, options?: Exactly<IncludeOptions<Include>, Options>): Promise<StoryRecord>;
     move<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: MoveRequest, options?: Exactly<IncludeOptions<Include>, Options> & {
         force?: true;
     }): Promise<ChangeNewsroomSuccessResponse<StoryRecord> | ChangeNewsroomUnsafeResponse>;

package/dist/endpoints/Stories/Client.js

@@ -115,7 +115,10 @@ export class Client {
     });
     return story;
   }
-  async translate(id, payload, options) {
+  async translate(id, payload = {}, options) {
+    const {
+      culture
+    } = payload ?? {};
     const include = options?.include;
     const url = `${routing.storiesUrl}/${id}/translate`;
     const {
@@ -124,7 +127,9 @@ export class Client {
       query: {
         include: include
       },
-      payload
+      payload: {
+        culture
+      }
     });
     return story;
   }

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

@@ -171,7 +171,7 @@ export interface ScheduleRequest {
 }
 export declare type UnscheduleRequest = UnpublishRequest;
 export interface TranslateRequest {
-    culture: CultureRef['code'];
+    culture?: CultureRef['code'];
 }
 export interface MoveRequest {
     newsroom: Newsroom['uuid'] | Newsroom['id'];

package/dist/types/Newsroom.cjs

@@ -27,4 +27,25 @@ exports.Newsroom = Newsroom;
     TrackingPolicy["CONSENT_TO_IDENTIFY"] = "consent-to-identify";
   })(TrackingPolicy || (TrackingPolicy = {}));
   _Newsroom.TrackingPolicy = TrackingPolicy;
+  function isActive(arg) {
+    if (typeof arg === 'string') {
+      return arg === Status.ACTIVE;
+    }
+    return isActive(arg.status);
+  }
+  _Newsroom.isActive = isActive;
+  function isInactive(arg) {
+    if (typeof arg === 'string') {
+      return arg === Status.INACTIVE;
+    }
+    return isInactive(arg.status);
+  }
+  _Newsroom.isInactive = isInactive;
+  function isArchived(arg) {
+    if (typeof arg === 'string') {
+      return arg === Status.ARCHIVED;
+    }
+    return isArchived(arg.status);
+  }
+  _Newsroom.isArchived = isArchived;
 })(Newsroom || (exports.Newsroom = Newsroom = {}));

package/dist/types/Newsroom.d.ts

@@ -133,4 +133,10 @@ export declare namespace Newsroom {
         DISABLED = "disabled",
         CONSENT_TO_IDENTIFY = "consent-to-identify"
     }
+    function isActive(newsroom: Newsroom['status']): boolean;
+    function isActive(newsroom: Pick<Newsroom, 'status'>): boolean;
+    function isInactive(newsroom: Newsroom['status']): boolean;
+    function isInactive(newsroom: Pick<Newsroom, 'status'>): boolean;
+    function isArchived(newsroom: Newsroom['status']): boolean;
+    function isArchived(newsroom: Pick<Newsroom, 'status'>): boolean;
 }

package/dist/types/Newsroom.js

@@ -20,4 +20,25 @@ export let Newsroom;
     TrackingPolicy["CONSENT_TO_IDENTIFY"] = "consent-to-identify";
   })(TrackingPolicy || (TrackingPolicy = {}));
   _Newsroom.TrackingPolicy = TrackingPolicy;
+  function isActive(arg) {
+    if (typeof arg === 'string') {
+      return arg === Status.ACTIVE;
+    }
+    return isActive(arg.status);
+  }
+  _Newsroom.isActive = isActive;
+  function isInactive(arg) {
+    if (typeof arg === 'string') {
+      return arg === Status.INACTIVE;
+    }
+    return isInactive(arg.status);
+  }
+  _Newsroom.isInactive = isInactive;
+  function isArchived(arg) {
+    if (typeof arg === 'string') {
+      return arg === Status.ARCHIVED;
+    }
+    return isArchived(arg.status);
+  }
+  _Newsroom.isArchived = isArchived;
 })(Newsroom || (Newsroom = {}));

package/dist/types/Story.cjs

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.Story = void 0;
+var _Newsroom = require("./Newsroom.cjs");
 let Story;
 exports.Story = Story;
 (function (_Story) {
@@ -13,15 +14,22 @@ exports.Story = Story;
     FormatVersion[FormatVersion["SLATEJS"] = 3] = "SLATEJS";
   })(FormatVersion || (FormatVersion = {}));
   _Story.FormatVersion = FormatVersion;
-  let LifecycleStatus;
-  (function (LifecycleStatus) {
-    LifecycleStatus["UNINITIALIZED"] = "uninitialized";
-    LifecycleStatus["DRAFT"] = "draft";
-    LifecycleStatus["SCHEDULED"] = "scheduled";
-    LifecycleStatus["EMBARGO"] = "embargo";
-    LifecycleStatus["PUBLISHED"] = "published";
-  })(LifecycleStatus || (LifecycleStatus = {}));
-  _Story.LifecycleStatus = LifecycleStatus;
+  let Status;
+  (function (Status) {
+    Status["UNINITIALIZED"] = "uninitialized";
+    Status["DRAFT"] = "draft";
+    Status["SCHEDULED"] = "scheduled";
+    Status["EMBARGO"] = "embargo";
+    Status["PUBLISHED"] = "published";
+  })(Status || (Status = {}));
+  _Story.Status = Status;
+  /**
+   * @deprecated Please use `Status` instead.
+   * @see Status
+   */var LifecycleStatus = Status; /**
+                                    * @deprecated Please use `Status` instead.
+                                    * @see Status
+                                    */
   let PublicationStatus;
   (function (PublicationStatus) {
     PublicationStatus["NEW"] = "new";
@@ -37,39 +45,51 @@ exports.Story = Story;
     Visibility["CONFIDENTIAL"] = "confidential";
   })(Visibility || (Visibility = {}));
   _Story.Visibility = Visibility;
+  function isActiveNewsroom(story) {
+    return _Newsroom.Newsroom.isActive(story.newsroom);
+  }
+  _Story.isActiveNewsroom = isActiveNewsroom;
+  function isInactiveNewsroom(story) {
+    return _Newsroom.Newsroom.isInactive(story.newsroom);
+  }
+  _Story.isInactiveNewsroom = isInactiveNewsroom;
+  function isArchivedNewsroom(story) {
+    return _Newsroom.Newsroom.isArchived(story.newsroom);
+  }
+  _Story.isArchivedNewsroom = isArchivedNewsroom;
   function isUninitialized(arg) {
     if (typeof arg === 'object') {
-      return isUninitialized(arg.lifecycle_status);
+      return isUninitialized(arg.status);
     }
-    return arg === LifecycleStatus.UNINITIALIZED;
+    return arg === Status.UNINITIALIZED;
   }
   _Story.isUninitialized = isUninitialized;
   function isDraft(arg) {
     if (typeof arg === 'object') {
-      return isDraft(arg.lifecycle_status);
+      return isDraft(arg.status);
     }
-    return arg === LifecycleStatus.DRAFT;
+    return arg === Status.DRAFT;
   }
   _Story.isDraft = isDraft;
   function isScheduled(arg) {
     if (typeof arg === 'object') {
-      return isScheduled(arg.lifecycle_status);
+      return isScheduled(arg.status);
     }
-    return arg === LifecycleStatus.SCHEDULED;
+    return arg === Status.SCHEDULED;
   }
   _Story.isScheduled = isScheduled;
   function isScheduledEmbargo(arg) {
     if (typeof arg === 'object') {
-      return isScheduledEmbargo(arg.lifecycle_status);
+      return isScheduledEmbargo(arg.status);
     }
-    return arg === LifecycleStatus.EMBARGO;
+    return arg === Status.EMBARGO;
   }
   _Story.isScheduledEmbargo = isScheduledEmbargo;
   function isPublished(arg) {
     if (typeof arg === 'object') {
-      return isPublished(arg.lifecycle_status);
+      return isPublished(arg.status);
     }
-    return arg === LifecycleStatus.PUBLISHED;
+    return arg === Status.PUBLISHED;
   }
   _Story.isPublished = isPublished;
   function isLegacyHtmlFormat(arg) {

package/dist/types/Story.d.ts

@@ -1,7 +1,7 @@
 import type { Category } from './Category';
 import type { OEmbedInfo } from './common';
 import type { CultureRef } from './Culture';
-import type { NewsroomRef } from './Newsroom';
+import { type NewsroomRef } from './Newsroom';
 import type { SEOSettings } from './SEOSettings';
 import type { UserRef } from './User';
 export interface StoryRef {
@@ -13,13 +13,19 @@ export interface StoryRef {
     id: number;
     title: string;
     slug: string;
+    status: Story.Status;
     /**
-     * @deprecated Please use `lifecycle_status` instead.
-     * @see lifecycle_status
-     * @see Story.LifecycleStatus
+     * @deprecated Please use `status` instead.
+     * @see status
+     * @see Story.Status
      */
-    publication_status: Story.PublicationStatus;
     lifecycle_status: Story.LifecycleStatus;
+    /**
+     * @deprecated Please use `status` instead.
+     * @see status
+     * @see Story.Status
+     */
+    publication_status: Story.PublicationStatus;
     visibility: Story.Visibility;
     thumbnail_url: string;
     created_at: string;
@@ -78,7 +84,11 @@ export interface Story {
     updated_at: string;
     published_at: string | null;
     scheduled_at: string | null;
-    lifecycle_status: Story.LifecycleStatus;
+    status: Story.Status;
+    /**
+     * @deprecated Please use `status` instead.
+     */
+    lifecycle_status: Story.Status;
     /**
      * @deprecated Please use `newsroom.status` instead.
      * @see newsroom
@@ -86,27 +96,27 @@ export interface Story {
      */
     is_archived: boolean;
     /**
-     * @deprecated Please use `lifecycle_status` instead.
-     * @see lifecycle_status
-     * @see Story.LifecycleStatus
+     * @deprecated Please use `status` instead.
+     * @see status
+     * @see Story.Status
      */
     is_finalized: boolean;
     /**
-     * @deprecated Please use `lifecycle_status` instead.
-     * @see lifecycle_status
-     * @see Story.LifecycleStatus
+     * @deprecated Please use `status` instead.
+     * @see status
+     * @see Story.Status
      */
     is_published: boolean;
     /**
-     * @deprecated Please use `lifecycle_status` instead.
-     * @see lifecycle_status
-     * @see Story.LifecycleStatus
+     * @deprecated Please use `status` instead.
+     * @see status
+     * @see Story.Status
      */
     is_draft: boolean;
     /**
-     * @deprecated Please use `lifecycle_status` instead.
-     * @see lifecycle_status
-     * @see Story.LifecycleStatus
+     * @deprecated Please use `status` instead.
+     * @see status
+     * @see Story.Status
      */
     is_embargo: boolean;
     /**
@@ -116,18 +126,18 @@ export interface Story {
      */
     is_private: boolean;
     /**
-     * @deprecated Please use `lifecycle_status` instead.
-     * @see lifecycle_status
-     * @see Story.LifecycleStatus
+     * @deprecated Please use `status` instead.
+     * @see status
+     * @see Story.Status
      */
     is_scheduled: boolean;
     is_sharable: boolean;
     is_analytics_available: boolean;
     is_shared_to_prpro: boolean;
     /**
-     * @deprecated Please use `lifecycle_status` instead.
-     * @see lifecycle_status
-     * @see Story.LifecycleStatus
+     * @deprecated Please use `status` instead.
+     * @see status
+     * @see Story.Status
      */
     publication_status: Story.PublicationStatus;
     visibility: Story.Visibility;
@@ -140,7 +150,7 @@ export declare namespace Story {
         HTML = 1,
         SLATEJS = 3
     }
-    enum LifecycleStatus {
+    enum Status {
         UNINITIALIZED = "uninitialized",
         DRAFT = "draft",
         SCHEDULED = "scheduled",
@@ -148,8 +158,13 @@ export declare namespace Story {
         PUBLISHED = "published"
     }
     /**
-     * Please use `LifecycleStatus` instead.
-     * @see LifecycleStatus
+     * @deprecated Please use `Status` instead.
+     * @see Status
+     */
+    export import LifecycleStatus = Status;
+    /**
+     * @deprecated Please use `Status` instead.
+     * @see Status
      */
     enum PublicationStatus {
         NEW = "new",
@@ -237,16 +252,19 @@ export declare namespace Story {
          */
         'pitches.count': number;
     }
-    function isUninitialized(status: LifecycleStatus): boolean;
-    function isUninitialized(story: Pick<Story, 'lifecycle_status'>): boolean;
-    function isDraft(status: LifecycleStatus): boolean;
-    function isDraft(story: Pick<Story, 'lifecycle_status'>): boolean;
-    function isScheduled(status: LifecycleStatus): boolean;
-    function isScheduled(story: Pick<Story, 'lifecycle_status'>): boolean;
-    function isScheduledEmbargo(status: LifecycleStatus): boolean;
-    function isScheduledEmbargo(story: Pick<Story, 'lifecycle_status'>): boolean;
-    function isPublished(status: LifecycleStatus): boolean;
-    function isPublished(story: Pick<Story, 'lifecycle_status'>): boolean;
+    function isActiveNewsroom(story: Pick<Story, 'newsroom'>): boolean;
+    function isInactiveNewsroom(story: Pick<Story, 'newsroom'>): boolean;
+    function isArchivedNewsroom(story: Pick<Story, 'newsroom'>): boolean;
+    function isUninitialized(status: Status): boolean;
+    function isUninitialized(story: Pick<Story, 'status'>): boolean;
+    function isDraft(status: Status): boolean;
+    function isDraft(story: Pick<Story, 'status'>): boolean;
+    function isScheduled(status: Status): boolean;
+    function isScheduled(story: Pick<Story, 'status'>): boolean;
+    function isScheduledEmbargo(status: Status): boolean;
+    function isScheduledEmbargo(story: Pick<Story, 'status'>): boolean;
+    function isPublished(status: Status): boolean;
+    function isPublished(story: Pick<Story, 'status'>): boolean;
     function isLegacyHtmlFormat(format: FormatVersion): format is FormatVersion.HTML;
     function isLegacyHtmlFormat<T extends Pick<Story, 'format_version'>>(story: T): story is T & {
         format_version: FormatVersion.HTML;

package/dist/types/Story.js

@@ -1,3 +1,4 @@
+import { Newsroom } from "./Newsroom.js";
 export let Story;
 (function (_Story) {
   let FormatVersion;
@@ -6,15 +7,22 @@ export let Story;
     FormatVersion[FormatVersion["SLATEJS"] = 3] = "SLATEJS";
   })(FormatVersion || (FormatVersion = {}));
   _Story.FormatVersion = FormatVersion;
-  let LifecycleStatus;
-  (function (LifecycleStatus) {
-    LifecycleStatus["UNINITIALIZED"] = "uninitialized";
-    LifecycleStatus["DRAFT"] = "draft";
-    LifecycleStatus["SCHEDULED"] = "scheduled";
-    LifecycleStatus["EMBARGO"] = "embargo";
-    LifecycleStatus["PUBLISHED"] = "published";
-  })(LifecycleStatus || (LifecycleStatus = {}));
-  _Story.LifecycleStatus = LifecycleStatus;
+  let Status;
+  (function (Status) {
+    Status["UNINITIALIZED"] = "uninitialized";
+    Status["DRAFT"] = "draft";
+    Status["SCHEDULED"] = "scheduled";
+    Status["EMBARGO"] = "embargo";
+    Status["PUBLISHED"] = "published";
+  })(Status || (Status = {}));
+  _Story.Status = Status;
+  /**
+   * @deprecated Please use `Status` instead.
+   * @see Status
+   */var LifecycleStatus = Status; /**
+                                    * @deprecated Please use `Status` instead.
+                                    * @see Status
+                                    */
   let PublicationStatus;
   (function (PublicationStatus) {
     PublicationStatus["NEW"] = "new";
@@ -30,39 +38,51 @@ export let Story;
     Visibility["CONFIDENTIAL"] = "confidential";
   })(Visibility || (Visibility = {}));
   _Story.Visibility = Visibility;
+  function isActiveNewsroom(story) {
+    return Newsroom.isActive(story.newsroom);
+  }
+  _Story.isActiveNewsroom = isActiveNewsroom;
+  function isInactiveNewsroom(story) {
+    return Newsroom.isInactive(story.newsroom);
+  }
+  _Story.isInactiveNewsroom = isInactiveNewsroom;
+  function isArchivedNewsroom(story) {
+    return Newsroom.isArchived(story.newsroom);
+  }
+  _Story.isArchivedNewsroom = isArchivedNewsroom;
   function isUninitialized(arg) {
     if (typeof arg === 'object') {
-      return isUninitialized(arg.lifecycle_status);
+      return isUninitialized(arg.status);
     }
-    return arg === LifecycleStatus.UNINITIALIZED;
+    return arg === Status.UNINITIALIZED;
   }
   _Story.isUninitialized = isUninitialized;
   function isDraft(arg) {
     if (typeof arg === 'object') {
-      return isDraft(arg.lifecycle_status);
+      return isDraft(arg.status);
     }
-    return arg === LifecycleStatus.DRAFT;
+    return arg === Status.DRAFT;
   }
   _Story.isDraft = isDraft;
   function isScheduled(arg) {
     if (typeof arg === 'object') {
-      return isScheduled(arg.lifecycle_status);
+      return isScheduled(arg.status);
     }
-    return arg === LifecycleStatus.SCHEDULED;
+    return arg === Status.SCHEDULED;
   }
   _Story.isScheduled = isScheduled;
   function isScheduledEmbargo(arg) {
     if (typeof arg === 'object') {
-      return isScheduledEmbargo(arg.lifecycle_status);
+      return isScheduledEmbargo(arg.status);
     }
-    return arg === LifecycleStatus.EMBARGO;
+    return arg === Status.EMBARGO;
   }
   _Story.isScheduledEmbargo = isScheduledEmbargo;
   function isPublished(arg) {
     if (typeof arg === 'object') {
-      return isPublished(arg.lifecycle_status);
+      return isPublished(arg.status);
     }
-    return arg === LifecycleStatus.PUBLISHED;
+    return arg === Status.PUBLISHED;
   }
   _Story.isPublished = isPublished;
   function isLegacyHtmlFormat(arg) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@prezly/sdk",
-    "version": "12.5.0",
+    "version": "12.6.0",
     "description": "Prezly API SDK",
     "type": "module",
     "main": "dist/index.cjs",