@prezly/sdk 18.2.0 → 18.2.2

package/dist/api/constants.cjs

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

package/dist/endpoints/Stories/Client.cjs

@@ -7,6 +7,7 @@ exports.Client = void 0;
 var _index = require("../../http/index.cjs");
 var _routing = require("../../routing.cjs");
 var _index2 = require("../../types/index.cjs");
+var _types = require("./types.cjs");
 class Client {
   constructor(apiClient) {
     this.apiClient = apiClient;
@@ -81,7 +82,7 @@ class Client {
             $in: arg
           }
         },
-        include,
+        include: [..._types.EXTENDED_STORY_INCLUDED_EXTRA_FIELDS, ...(include ?? [])],
         formats
       });
       return stories;
@@ -96,7 +97,7 @@ class Client {
             $in: arg
           }
         },
-        include,
+        include: [..._types.EXTENDED_STORY_INCLUDED_EXTRA_FIELDS, ...(include ?? [])],
         formats
       });
       return stories;
@@ -106,7 +107,7 @@ class Client {
     } = await this.apiClient.get(`${_routing.routing.storiesUrl}/${arg}`, {
       headers: acceptedFormatsHeader(formats),
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -122,7 +123,7 @@ class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -138,7 +139,7 @@ class Client {
     } = await this.apiClient.post(url, {
       headers: acceptedFormatsHeader(formats),
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -157,7 +158,7 @@ class Client {
     } = await this.apiClient.post(url, {
       headers: acceptedFormatsHeader(formats),
       query: {
-        include: include
+        include
       },
       payload: {
         culture

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

@@ -10,85 +10,122 @@ declare type Formats = Story.FormatVersion[];
  * Utility type to forbid arbitrary ad-hoc extensions of generic parameters.
  * @see https://stackoverflow.com/a/69666350
  */
-declare type Exactly<T, X> = T & Record<Exclude<keyof X, keyof T>, never>;
+declare type Exactly<Concrete, Abstract> = Concrete & Record<Exclude<keyof Concrete, keyof Abstract>, never>;
+declare type InferExtraFields<T> = T extends Required<IncludeOptions<infer I>> ? Pick<Story.ExtraFields, I> : unknown;
 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?: Exactly<ListOptions<Include>, Options>): Promise<ListResponse<StoryRecord>>;
-    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?: Exactly<SearchOptions<Include>, Options>): Promise<ListResponse<StoryRecord>>;
+    list<Options extends ListOptions>(options?: Exactly<Options, ListOptions>): Promise<ListResponse<Story & InferExtraFields<Options>>>;
+    search<Options extends SearchOptions>(options?: Exactly<Options, SearchOptions>): Promise<ListResponse<Story & InferExtraFields<Options>>>;
     /**
      * 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?: Exactly<IncludeOptions<Include>, Options> & {
+    get<Options extends IncludeOptions & {
         formats?: Formats;
-    }): Promise<StoryRecord>;
+    }>(id: Story['uuid'], options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+    }>): Promise<ExtendedStory & InferExtraFields<Options>>;
     /**
      * 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?: Exactly<IncludeOptions<Include>, Options> & {
+    get<Options extends IncludeOptions & {
+        formats?: Formats;
+    }>(ids: Story['uuid'][], options?: Exactly<Options, IncludeOptions & {
         formats?: Formats;
-    }): Promise<StoryRecord[]>;
+    }>): Promise<(ExtendedStory & InferExtraFields<Options>)[]>;
     /**
      * 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?: Exactly<IncludeOptions<Include>, Options> & {
+    get<Options extends IncludeOptions & {
+        formats?: Formats;
+    }>(id: Story['id'] | Story['uuid'], options?: Exactly<Options, IncludeOptions & {
         formats?: Formats;
-    }): Promise<StoryRecord>;
+    }>): Promise<ExtendedStory & InferExtraFields<Options>>;
     /**
      * 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?: Exactly<IncludeOptions<Include>, Options> & {
+    get<Options extends IncludeOptions & {
+        formats?: Formats;
+    }>(ids: Story['id'][], options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+    }>): Promise<(ExtendedStory & InferExtraFields<Options>)[]>;
+    create<Options extends IncludeOptions & {
         formats?: Formats;
-    }): 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> & {
+    }>(payload: CreateRequest, options?: Exactly<Options, IncludeOptions & {
         formats?: Formats;
-    }): 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<ExtendedStory & InferExtraFields<Options>>;
+    duplicate<Options extends IncludeOptions & {
         formats?: Formats;
-    }): 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> & {
+    }>(id: StoryId, options?: Exactly<Options, IncludeOptions & {
         formats?: Formats;
-    }): 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> & {
+    }>): Promise<ExtendedStory & InferExtraFields<Options>>;
+    translate<Options extends IncludeOptions & {
+        formats?: Formats;
+    }>(id: StoryId, payload?: TranslateRequest, options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+    }>): Promise<ExtendedStory & InferExtraFields<Options>>;
+    move<Options extends IncludeOptions & {
         force?: true;
         formats?: Formats;
-    }): Promise<ChangeNewsroomSuccessResponse<StoryRecord> | ChangeNewsroomUnsafeResponse>;
-    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?: Exactly<IncludeOptions<Include>, Options> & {
+    }>(id: StoryId, payload: MoveRequest, options?: Exactly<Options, IncludeOptions & {
+        force?: true;
+        formats?: Formats;
+    }>): Promise<ChangeNewsroomSuccessResponse<ExtendedStory & InferExtraFields<Options>> | ChangeNewsroomUnsafeResponse>;
+    update<Options extends IncludeOptions & {
+        formats?: Formats;
+    }>(id: StoryId, payload: UpdateRequest, options?: Exactly<Options, IncludeOptions & {
         formats?: Formats;
-    }): Promise<StoryRecord>;
+    }>): Promise<ExtendedStory & InferExtraFields<Options>>;
     /**
      * 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?: Exactly<IncludeOptions<Include>, Options> & {
+    autosave<Options extends IncludeOptions & {
         formats?: Formats;
-    }): Promise<StoryRecord>;
+    }>(id: StoryId, payload: AutosaveRequest, options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+    }>): Promise<ExtendedStory & InferExtraFields<Options>>;
     /**
      * 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?: Exactly<IncludeOptions<Include>, Options> & {
+    revert<Options extends IncludeOptions & {
+        formats?: Formats;
+    }>(id: StoryId, payload?: RevertRequest, options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+    }>): Promise<ExtendedStory & InferExtraFields<Options>>;
+    publish<Options extends IncludeOptions & {
+        formats?: Formats;
+    }>(id: StoryId, payload?: PublishRequest, options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+    }>): Promise<ExtendedStory & InferExtraFields<Options>>;
+    unpublish<Options extends IncludeOptions & {
         formats?: Formats;
-    }): 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?: Exactly<IncludeOptions<Include>, Options> & {
+    }>(id: StoryId, payload?: UnpublishRequest, options?: Exactly<Options, IncludeOptions & {
         formats?: Formats;
-    }): 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?: Exactly<IncludeOptions<Include>, Options> & {
+    }>): Promise<ExtendedStory & InferExtraFields<Options>>;
+    schedule<Options extends IncludeOptions & {
         formats?: Formats;
-    }): 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?: Exactly<IncludeOptions<Include>, Options> & {
+    }>(id: StoryId, payload?: ScheduleRequest, options?: Exactly<Options, IncludeOptions & {
         formats?: Formats;
-    }): 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?: Exactly<IncludeOptions<Include>, Options> & {
+    }>): Promise<ExtendedStory & InferExtraFields<Options>>;
+    unschedule<Options extends IncludeOptions & {
         formats?: Formats;
-    }): Promise<StoryRecord>;
-    pin<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> & {
+    }>(id: StoryId, payload?: UnscheduleRequest, options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+    }>): Promise<ExtendedStory & InferExtraFields<Options>>;
+    pin<Options extends IncludeOptions & {
+        force?: boolean;
+        formats?: Formats;
+    }>(id: StoryId, options?: Exactly<Options, IncludeOptions & {
         force?: boolean;
         formats?: Formats;
-    }): Promise<StoryRecord>;
-    unpin<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<ExtendedStory & InferExtraFields<Options>>;
+    unpin<Options extends IncludeOptions & {
+        formats?: Formats;
+    }>(id: StoryId, options?: Exactly<Options, IncludeOptions & {
         formats?: Formats;
-    }): Promise<StoryRecord>;
+    }>): Promise<ExtendedStory & InferExtraFields<Options>>;
     delete(id: StoryId): Promise<void>;
     preview(id: StoryId, options?: PreviewOptions): Promise<PreviewResponse>;
 }

package/dist/endpoints/Stories/Client.js

@@ -1,6 +1,9 @@
 import { ApiError, HttpCodes } from "../../http/index.js";
 import { routing } from "../../routing.js";
 import { SortOrder } from "../../types/index.js";
+import { EXTENDED_STORY_INCLUDED_EXTRA_FIELDS } from "./types.js"; /**
+                                                                    * `uuid` is the preferred way of targeting a Story. Numeric `id` is considered deprecated.
+                                                                    */
 export class Client {
   constructor(apiClient) {
     this.apiClient = apiClient;
@@ -75,7 +78,7 @@ export class Client {
             $in: arg
           }
         },
-        include,
+        include: [...EXTENDED_STORY_INCLUDED_EXTRA_FIELDS, ...(include ?? [])],
         formats
       });
       return stories;
@@ -90,7 +93,7 @@ export class Client {
             $in: arg
           }
         },
-        include,
+        include: [...EXTENDED_STORY_INCLUDED_EXTRA_FIELDS, ...(include ?? [])],
         formats
       });
       return stories;
@@ -100,7 +103,7 @@ export class Client {
     } = await this.apiClient.get(`${routing.storiesUrl}/${arg}`, {
       headers: acceptedFormatsHeader(formats),
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -116,7 +119,7 @@ export class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -132,7 +135,7 @@ export class Client {
     } = await this.apiClient.post(url, {
       headers: acceptedFormatsHeader(formats),
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -151,7 +154,7 @@ export class Client {
     } = await this.apiClient.post(url, {
       headers: acceptedFormatsHeader(formats),
       query: {
-        include: include
+        include
       },
       payload: {
         culture

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

@@ -49,18 +49,18 @@ interface StoryEmbeddedContactsWillBeRemovedWarning extends BaseWarning {
     value: NewsroomContactRef[];
 }
 export declare type ChangeNewsroomWarning = ChangingNewsroomUnsafeOperationWarning | DestinationNewsroomMissingCategoriesWarning | DestinationNewsroomMissingCulturesWarning | StoryEmbeddedContactsWillBeRemovedWarning | StoryTranslationsWillMoveWarning;
-export interface IncludeOptions<Include extends readonly (keyof Story.ExtraFields)[]> {
-    include?: Include;
+export interface IncludeOptions<Include extends keyof Story.ExtraFields = keyof Story.ExtraFields> {
+    include?: Include[];
 }
-export interface ListOptions<Include extends readonly (keyof Story.ExtraFields)[]> {
+export interface ListOptions<Include extends keyof Story.ExtraFields = keyof Story.ExtraFields> {
     search?: string;
     limit?: number;
     offset?: number;
     sortOrder?: SortOrder | string;
-    include?: Include;
+    include?: Include[];
     formats?: Story.FormatVersion[];
 }
-export interface SearchOptions<Include extends readonly (keyof Story.ExtraFields)[]> extends ListOptions<Include> {
+export interface SearchOptions<Include extends keyof Story.ExtraFields = keyof Story.ExtraFields> extends ListOptions<Include> {
     query?: Query;
     scope?: Query;
 }

package/dist/types/License.d.ts

@@ -80,6 +80,7 @@ export interface License extends LicenseRef {
     total_seats: number;
     type: License.Type;
     vat_nr: string;
+    po_number: string | null;
     /**
      * A combination of a number and the interval type ("day", "week", "month", "year"), separated by "/".
      *

package/package.json

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