npm - @wix/portfolio - Versions diffs - 1.0.0 - Mend

@wix/portfolio 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (79) hide show

package/build/cjs/src/portfolio-collections-v1-collection.universal.d.ts ADDED Viewed

@@ -0,0 +1,449 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+/** Collection is the main entity of CollectionsService */
+export interface Collection {
+    /**
+     * Collection ID
+     * @readonly
+     */
+    _id?: string | null;
+    /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */
+    revision?: string | null;
+    title?: string | null;
+    description?: string | null;
+    /** Url of Collection // TODO: ask Idan */
+    slug?: string | null;
+    /** Collection's cover photo */
+    coverImage?: Image;
+    /** Indicates if the collection is hidden from Portfolio */
+    hidden?: boolean | null;
+    /** if not present in an update it means the collection will be added as currentTimestamp - as the last collection */
+    sortOrder?: number | null;
+    /**
+     * Represents the time this Collection was created
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Represents the time this Collection was last updated
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /**
+     * Url and relative url of Collection - in order to receive this field in READ requests you will need to pass the `include_page_url` field as part of request
+     * @readonly
+     */
+    url?: string;
+    seoData?: SeoSchema;
+}
+export interface Image {
+    /** Image info - Wix Media Image. Required. */
+    imageInfo?: string;
+    /** Focal point of the image. */
+    focalPoint?: Point;
+    /** Set of key-value pairs describing the media in [Exchangeable Image File format](https://en.wikipedia.org/wiki/Exif). */
+    exif?: Record<string, any> | null;
+    /**
+     * Image compression level. <br />
+     *
+     * Min: `30` <br />
+     * Max: `100`
+     */
+    quality?: number | null;
+    /** [Unsharp masking](https://en.wikipedia.org/wiki/Unsharp_masking) values of the image. */
+    unsharpMasking?: UnsharpMasking;
+}
+export declare enum ImageType {
+    UNDEFINED = "UNDEFINED",
+    WIX_MEDIA = "WIX_MEDIA",
+    EXTERNAL = "EXTERNAL"
+}
+export interface Point {
+    /** X-coordinate of the focal point. */
+    x?: number;
+    /** Y-coordinate of the focal point. */
+    y?: number;
+}
+export interface UnsharpMasking {
+    /**
+     * Unsharp masking amount. Controls the sharpening strength. <br />
+     *
+     * Min: `0` <br />
+     * Max: `5`
+     */
+    amount?: number | null;
+    /** Unsharp masking radius in pixels. Controls the sharpening width. */
+    radius?: number | null;
+    /**
+     * Unsharp masking threshold. Controls how different neighboring pixels must be for shapening to apply. <br />
+     *
+     * Min: `0` <br />
+     * Max: `1`
+     */
+    threshold?: number | null;
+}
+/**
+ * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
+ * The search engines use this information for ranking purposes, or to display snippets in the search results.
+ * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
+ */
+export interface SeoSchema {
+    /** SEO tags information. */
+    tags?: Tag[];
+    /** SEO general settings. */
+    settings?: Settings;
+}
+export interface Tag {
+    /** SEO tag type. Supported values: `title`, `meta`, `script`, `link`. */
+    type?: string;
+    /** SEO tag attributes/properties (name, content, rel, href). */
+    props?: Record<string, any> | null;
+    /** Tag meta data, e.g. {height: 300, width: 240}. */
+    meta?: Record<string, any> | null;
+    /** Tag inner content e.g. `<title> inner content </title>`. */
+    children?: string;
+    /** Whether the tag is a custom tag. */
+    custom?: boolean;
+    /** Whether the tag is disabled. */
+    disabled?: boolean;
+}
+export interface Settings {
+    /** disable auto creation of 301 redirects on slug changes (enabled by default). */
+    preventAutoRedirect?: boolean;
+}
+export interface CommonImage {
+    /** Image info - Wix Media Image. Required. */
+    imageInfo?: string;
+    /** Focal point of the image. */
+    focalPoint?: CommonPoint;
+    /** Set of key-value pairs describing the media in [Exchangeable Image File format](https://en.wikipedia.org/wiki/Exif). */
+    exif?: Record<string, any> | null;
+    /**
+     * Image compression level. <br />
+     *
+     * Min: `30` <br />
+     * Max: `100`
+     */
+    quality?: number | null;
+    /** [Unsharp masking](https://en.wikipedia.org/wiki/Unsharp_masking) values of the image. */
+    unsharpMasking?: CommonUnsharpMasking;
+}
+export declare enum ImageImageType {
+    UNDEFINED = "UNDEFINED",
+    WIX_MEDIA = "WIX_MEDIA",
+    EXTERNAL = "EXTERNAL"
+}
+export interface CommonPoint {
+    /** X-coordinate of the focal point. */
+    x?: number;
+    /** Y-coordinate of the focal point. */
+    y?: number;
+}
+export interface CommonUnsharpMasking {
+    /**
+     * Unsharp masking amount. Controls the sharpening strength. <br />
+     *
+     * Min: `0` <br />
+     * Max: `5`
+     */
+    amount?: number | null;
+    /** Unsharp masking radius in pixels. Controls the sharpening width. */
+    radius?: number | null;
+    /**
+     * Unsharp masking threshold. Controls how different neighboring pixels must be for shapening to apply. <br />
+     *
+     * Min: `0` <br />
+     * Max: `1`
+     */
+    threshold?: number | null;
+}
+export interface InvalidateCache extends InvalidateCacheGetByOneOf {
+    /** tell us why you're invalidating the cache. You don't need to add your app name */
+    reason?: string | null;
+    /** Is local DS */
+    localDc?: boolean;
+    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    metaSiteId?: string;
+    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    siteId?: string;
+    /** Invalidate by App */
+    app?: App;
+    /** Invalidate by page id */
+    page?: Page;
+    /** Invalidate by URI path */
+    uri?: URI;
+}
+/** @oneof */
+export interface InvalidateCacheGetByOneOf {
+    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    metaSiteId?: string;
+    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    siteId?: string;
+    /** Invalidate by App */
+    app?: App;
+    /** Invalidate by page id */
+    page?: Page;
+    /** Invalidate by URI path */
+    uri?: URI;
+}
+export interface App {
+    /** The AppDefId */
+    appDefId?: string;
+    /** The instance Id */
+    instanceId?: string;
+}
+export interface Page {
+    /** the msid the page is on */
+    metaSiteId?: string;
+    /** Invalidate by Page ID */
+    pageId?: string;
+}
+export interface URI {
+    /** the msid the URI is on */
+    metaSiteId?: string;
+    /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
+    uriPath?: string;
+}
+export interface CreateCollectionRequest {
+    /** Collection to be created */
+    collection: Collection;
+}
+export interface CreateCollectionResponse {
+    /** The created Collection */
+    collection?: Collection;
+}
+export interface GetCollectionRequest {
+    /** Id of the Collection to retrieve */
+    collectionId: string;
+    includePageUrl?: boolean | null;
+}
+export interface GetCollectionResponse {
+    /** The retrieved Collection */
+    collection?: Collection;
+}
+export interface ListCollectionsRequest {
+    /** Maximum limit per response is 100, in first request cursor is None */
+    paging?: CursorPaging;
+    includePageUrl?: boolean | null;
+}
+export interface CursorPaging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+export interface ListCollectionsResponse {
+    /** Retrieved Collections */
+    collections?: Collection[];
+    /** Paging metadata */
+    pagingMetadataV2?: PagingMetadataV2;
+    /** Paging metadata */
+    metadata?: PagingMetadataV2;
+}
+export interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+export interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+export interface UpdateCollectionRequest {
+    /** Collection to be updated, may be partial */
+    collection: Collection;
+    /** Explicit list of fields to update */
+    mask?: string[];
+}
+export interface UpdateCollectionResponse {
+    /** The updated Collection */
+    collection?: Collection;
+}
+export interface DeleteCollectionRequest {
+    /** Id of the Collection to delete */
+    collectionId: string;
+    /** The revision of the Collection */
+    revision?: string;
+}
+export interface DeleteCollectionResponse {
+    /** Id of the Deleted Collection */
+    collectionId?: string;
+}
+export interface QueryCollectionsRequest {
+    /** WQL expression */
+    query: QueryV2;
+    includePageUrl?: boolean | null;
+}
+export interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fields?: string[];
+    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fieldsets?: string[];
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+/** @oneof */
+export interface QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface QueryCollectionsResponse {
+    /** The retrieved Collections */
+    collections?: Collection[];
+    /** Paging metadata */
+    pagingMetadataV2?: PagingMetadataV2;
+    /** Paging metadata */
+    metadata?: PagingMetadataV2;
+}
+/**
+ * Creates a new Collection
+ * @param collection - Collection to be created
+ * @public
+ * @requiredField collection
+ * @returns The created Collection
+ */
+export declare function createCollection(collection: Collection): Promise<Collection>;
+/**
+ * Get a Collection by id
+ * @param collectionId - Id of the Collection to retrieve
+ * @public
+ * @requiredField collectionId
+ * @returns The retrieved Collection
+ */
+export declare function getCollection(collectionId: string, options?: GetCollectionOptions): Promise<Collection>;
+export interface GetCollectionOptions {
+    includePageUrl?: boolean | null;
+}
+/**
+ * List all Collections in portfolio
+ * @public */
+export declare function listCollections(options?: ListCollectionsOptions): Promise<ListCollectionsResponse>;
+export interface ListCollectionsOptions {
+    /** Maximum limit per response is 100, in first request cursor is None */
+    paging?: CursorPaging;
+    includePageUrl?: boolean | null;
+}
+/**
+ * Update a Collection, supports partial update
+ * Pass the latest `revision` for a successful update
+ * @param _id - Collection ID
+ * @public
+ * @requiredField _id
+ * @requiredField collection
+ * @requiredField collection.revision
+ * @returns The updated Collection
+ */
+export declare function updateCollection(_id: string | null, collection: UpdateCollection, options?: UpdateCollectionOptions): Promise<Collection>;
+export interface UpdateCollection {
+    /**
+     * Collection ID
+     * @readonly
+     */
+    _id?: string | null;
+    /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */
+    revision?: string | null;
+    title?: string | null;
+    description?: string | null;
+    /** Url of Collection // TODO: ask Idan */
+    slug?: string | null;
+    /** Collection's cover photo */
+    coverImage?: Image;
+    /** Indicates if the collection is hidden from Portfolio */
+    hidden?: boolean | null;
+    /** if not present in an update it means the collection will be added as currentTimestamp - as the last collection */
+    sortOrder?: number | null;
+    /**
+     * Represents the time this Collection was created
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Represents the time this Collection was last updated
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /**
+     * Url and relative url of Collection - in order to receive this field in READ requests you will need to pass the `include_page_url` field as part of request
+     * @readonly
+     */
+    url?: string;
+    seoData?: SeoSchema;
+}
+export interface UpdateCollectionOptions {
+    /** Explicit list of fields to update */
+    mask?: string[];
+}
+/**
+ * Delete a Collection
+ * @param collectionId - Id of the Collection to delete
+ * @public
+ * @requiredField collectionId
+ */
+export declare function deleteCollection(collectionId: string, options?: DeleteCollectionOptions): Promise<DeleteCollectionResponse>;
+export interface DeleteCollectionOptions {
+    /** The revision of the Collection */
+    revision?: string;
+}
+/**
+ * Query Collections using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
+ * @param query - WQL expression
+ * @public
+ * @requiredField query
+ */
+export declare function queryCollections(query: QueryV2, options?: QueryCollectionsOptions): Promise<QueryCollectionsResponse>;
+export interface QueryCollectionsOptions {
+    includePageUrl?: boolean | null;
+}