@prezly/sdk 18.2.2 → 18.3.0

package/dist/api/constants.cjs

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.DEFAULT_USER_AGENT = void 0;
-const VERSION = "18.2.1";
+const VERSION = "18.2.2";
 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 = "18.2.1";
+const VERSION = "18.2.2";
 const URL = 'https://github.com/prezly/javascript-sdk';
 export const DEFAULT_USER_AGENT = `prezly-javascript-sdk/${VERSION} (+${URL})`;

package/dist/endpoints/Stories/Client.cjs

@@ -112,22 +112,47 @@ class Client {
     });
     return story;
   }
-  async create(payload, options) {
+  async getBySlug(slug, options) {
+    if (slug.includes('/') || slug.includes('\\')) {
+      throw new Error('Story slugs cannot contain slashes.');
+    }
     const {
       include,
+      query,
       formats
     } = options ?? {};
     const {
       story
-    } = await this.apiClient.post(_routing.routing.storiesUrl, {
+    } = await this.apiClient.post(`${_routing.routing.storiesUrl}/by-slug/${slug}`, {
       headers: acceptedFormatsHeader(formats),
-      payload,
       query: {
         include
+      },
+      payload: {
+        query
       }
     });
     return story;
   }
+  async create(payload, options) {
+    const {
+      include,
+      formats,
+      force = false
+    } = options ?? {};
+    const {
+      story
+    } = await this.apiClient.post(_routing.routing.storiesUrl, {
+      headers: acceptedFormatsHeader(formats),
+      query: {
+        include,
+        force: force || undefined // only pass it if it's true
+      },
+
+      payload
+    });
+    return story;
+  }
   async duplicate(id, options) {
     const {
       include,
@@ -169,8 +194,8 @@ class Client {
   async move(id, payload, options) {
     const {
       include,
-      force,
-      formats
+      formats,
+      force = false
     } = options ?? {};
     const url = `${_routing.routing.storiesUrl}/${id}/move`;
     try {
@@ -179,9 +204,10 @@ class Client {
       } = await this.apiClient.post(url, {
         headers: acceptedFormatsHeader(formats),
         query: {
-          include: include,
-          force
+          include,
+          force: force || undefined // only pass it if it's true
         },
+
         payload
       });
       return {
@@ -199,16 +225,19 @@ class Client {
     const url = `${_routing.routing.storiesUrl}/${id}`;
     const {
       include,
-      formats
+      formats,
+      force = false
     } = options ?? {};
     const {
       story
     } = await this.apiClient.patch(url, {
       headers: acceptedFormatsHeader(formats),
-      payload,
       query: {
-        include: include
-      }
+        include,
+        force: force || undefined // only pass it if it's true
+      },
+
+      payload
     });
     return story;
   }
@@ -228,7 +257,7 @@ class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -249,7 +278,7 @@ class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -266,7 +295,7 @@ class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -283,7 +312,7 @@ class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -300,7 +329,7 @@ class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -317,7 +346,7 @@ class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -326,8 +355,8 @@ class Client {
     const url = `${_routing.routing.storiesUrl}/${id}/pin`;
     const {
       include,
-      force,
-      formats
+      formats,
+      force = false
     } = options ?? {};
     const {
       story
@@ -335,9 +364,10 @@ class Client {
       headers: acceptedFormatsHeader(formats),
       query: {
         include: include,
-        force: force || undefined
+        force: force || undefined // only pass it if it's true
       }
     });
+
     return story;
   }
   async unpin(id, options) {

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

@@ -1,5 +1,5 @@
 import type { DeferredJobsApiClient } from '../../api';
-import type { ExtendedStory, Story } from '../../types';
+import type { ExtendedStory, Query, Story } from '../../types';
 import type { AutosaveRequest, ChangeNewsroomSuccessResponse, ChangeNewsroomUnsafeResponse, CreateRequest, IncludeOptions, ListOptions, ListResponse, MoveRequest, PreviewResponse, PreviewOptions, PublishRequest, RevertRequest, ScheduleRequest, SearchOptions, TranslateRequest, UnpublishRequest, UnscheduleRequest, UpdateRequest } from './types';
 /**
  * `uuid` is the preferred way of targeting a Story. Numeric `id` is considered deprecated.
@@ -51,10 +51,19 @@ export declare class Client {
     }>(ids: Story['id'][], options?: Exactly<Options, IncludeOptions & {
         formats?: Formats;
     }>): Promise<(ExtendedStory & InferExtraFields<Options>)[]>;
+    getBySlug<Options extends IncludeOptions & {
+        formats?: Formats;
+        query?: Query;
+    }>(slug: Story['slug'], options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+        query?: Query;
+    }>): Promise<ExtendedStory & InferExtraFields<Options>>;
     create<Options extends IncludeOptions & {
         formats?: Formats;
+        force?: boolean;
     }>(payload: CreateRequest, options?: Exactly<Options, IncludeOptions & {
         formats?: Formats;
+        force?: boolean;
     }>): Promise<ExtendedStory & InferExtraFields<Options>>;
     duplicate<Options extends IncludeOptions & {
         formats?: Formats;
@@ -67,16 +76,18 @@ export declare class Client {
         formats?: Formats;
     }>): Promise<ExtendedStory & InferExtraFields<Options>>;
     move<Options extends IncludeOptions & {
-        force?: true;
         formats?: Formats;
+        force?: boolean;
     }>(id: StoryId, payload: MoveRequest, options?: Exactly<Options, IncludeOptions & {
-        force?: true;
         formats?: Formats;
+        force?: boolean;
     }>): Promise<ChangeNewsroomSuccessResponse<ExtendedStory & InferExtraFields<Options>> | ChangeNewsroomUnsafeResponse>;
     update<Options extends IncludeOptions & {
         formats?: Formats;
+        force?: boolean;
     }>(id: StoryId, payload: UpdateRequest, options?: Exactly<Options, IncludeOptions & {
         formats?: Formats;
+        force?: boolean;
     }>): Promise<ExtendedStory & InferExtraFields<Options>>;
     /**
      * This operation is only allowed for V3 stories
@@ -115,11 +126,11 @@ export declare class Client {
         formats?: Formats;
     }>): Promise<ExtendedStory & InferExtraFields<Options>>;
     pin<Options extends IncludeOptions & {
-        force?: boolean;
         formats?: Formats;
-    }>(id: StoryId, options?: Exactly<Options, IncludeOptions & {
         force?: boolean;
+    }>(id: StoryId, options?: Exactly<Options, IncludeOptions & {
         formats?: Formats;
+        force?: boolean;
     }>): Promise<ExtendedStory & InferExtraFields<Options>>;
     unpin<Options extends IncludeOptions & {
         formats?: Formats;

package/dist/endpoints/Stories/Client.js

@@ -108,22 +108,47 @@ export class Client {
     });
     return story;
   }
-  async create(payload, options) {
+  async getBySlug(slug, options) {
+    if (slug.includes('/') || slug.includes('\\')) {
+      throw new Error('Story slugs cannot contain slashes.');
+    }
     const {
       include,
+      query,
       formats
     } = options ?? {};
     const {
       story
-    } = await this.apiClient.post(routing.storiesUrl, {
+    } = await this.apiClient.post(`${routing.storiesUrl}/by-slug/${slug}`, {
       headers: acceptedFormatsHeader(formats),
-      payload,
       query: {
         include
+      },
+      payload: {
+        query
       }
     });
     return story;
   }
+  async create(payload, options) {
+    const {
+      include,
+      formats,
+      force = false
+    } = options ?? {};
+    const {
+      story
+    } = await this.apiClient.post(routing.storiesUrl, {
+      headers: acceptedFormatsHeader(formats),
+      query: {
+        include,
+        force: force || undefined // only pass it if it's true
+      },
+
+      payload
+    });
+    return story;
+  }
   async duplicate(id, options) {
     const {
       include,
@@ -165,8 +190,8 @@ export class Client {
   async move(id, payload, options) {
     const {
       include,
-      force,
-      formats
+      formats,
+      force = false
     } = options ?? {};
     const url = `${routing.storiesUrl}/${id}/move`;
     try {
@@ -175,9 +200,10 @@ export class Client {
       } = await this.apiClient.post(url, {
         headers: acceptedFormatsHeader(formats),
         query: {
-          include: include,
-          force
+          include,
+          force: force || undefined // only pass it if it's true
         },
+
         payload
       });
       return {
@@ -195,16 +221,19 @@ export class Client {
     const url = `${routing.storiesUrl}/${id}`;
     const {
       include,
-      formats
+      formats,
+      force = false
     } = options ?? {};
     const {
       story
     } = await this.apiClient.patch(url, {
       headers: acceptedFormatsHeader(formats),
-      payload,
       query: {
-        include: include
-      }
+        include,
+        force: force || undefined // only pass it if it's true
+      },
+
+      payload
     });
     return story;
   }
@@ -224,7 +253,7 @@ export class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -245,7 +274,7 @@ export class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -262,7 +291,7 @@ export class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -279,7 +308,7 @@ export class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -296,7 +325,7 @@ export class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -313,7 +342,7 @@ export class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -322,8 +351,8 @@ export class Client {
     const url = `${routing.storiesUrl}/${id}/pin`;
     const {
       include,
-      force,
-      formats
+      formats,
+      force = false
     } = options ?? {};
     const {
       story
@@ -331,9 +360,10 @@ export class Client {
       headers: acceptedFormatsHeader(formats),
       query: {
         include: include,
-        force: force || undefined
+        force: force || undefined // only pass it if it's true
       }
     });
+
     return story;
   }
   async unpin(id, options) {

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

@@ -70,6 +70,15 @@ export interface ListResponse<S extends Story = Story> {
     sort: string;
 }
 interface GenericCreateRequest {
+    /**
+     * Set a custom slug for a Story.
+     *
+     * - If there is another story with exactly the same slug value, the Create request will throw [HTTP 409 Conflict].
+     *
+     * - Conflicts can be force-resolved by passing `?force` GET parameter.
+     *   This will update other conflicting stories slugs to something else (i.e. adding random suffix).
+     */
+    slug?: Story['slug'];
     newsroom?: Newsroom['id'] | Newsroom['uuid'];
     published_at?: Iso8601DateTime;
     visibility?: Story.Visibility;
@@ -82,6 +91,16 @@ interface GenericCreateRequest {
     is_shared_to_prpro?: boolean;
 }
 interface GenericUpdateRequest {
+    /**
+     * Set a custom slug for a Story.
+     * Updating it to `null` will revert back to automatically generated slugs.
+     *
+     * - If there is another story with exactly the same slug value, the Update request will throw [HTTP 409 Conflict].
+     *
+     * - Conflicts can be force-resolved by passing `?force` GET parameter.
+     *   This will update other conflicting stories slugs to something else (i.e. adding random suffix).
+     */
+    slug?: Story['slug'] | null;
     published_at?: Iso8601DateTime;
     visibility?: Story.Visibility;
     culture?: CultureRef['code'];

package/package.json

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