@wix/metro 1.0.79 → 1.0.80

package/context/package.json

@@ -2,5 +2,6 @@
   "sideEffects": false,
   "module": "../build/es/context.js",
   "main": "../build/cjs/context.js",
-  "typings": "../build/cjs/context.d.ts"
+  "typings": "../build/cjs/context.d.ts",
+  "typesBundle": "../type-bundles/context.bundle.d.ts"
 }

package/meta/package.json

@@ -2,5 +2,6 @@
   "sideEffects": false,
   "module": "../build/es/meta.js",
   "main": "../build/cjs/meta.js",
-  "typings": "../build/cjs/meta.d.ts"
+  "typings": "../build/cjs/meta.d.ts",
+  "typesBundle": "../type-bundles/meta.bundle.d.ts"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/metro",
-  "version": "1.0.79",
+  "version": "1.0.80",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -9,21 +9,27 @@
   "module": "build/es/index.js",
   "main": "build/cjs/index.js",
   "typings": "./build/cjs/index.d.ts",
+  "typesBundle": "./type-bundles/index.bundle.d.ts",
   "files": [
     "build",
     "frontend/package.json",
     "meta",
-    "context"
+    "context",
+    "type-bundles"
   ],
   "dependencies": {
-    "@wix/metro_products": "1.0.5"
+    "@wix/metro_products": "1.0.6"
   },
   "devDependencies": {
     "@wix/sdk": "https://cdn.dev.wixpress.com/@wix/sdk/02e8069ab2fd783e0e6a080fc7d590e76cb26ab93c8389574286305b.tar.gz",
+    "glob": "^10.4.1",
+    "rollup": "^4.18.0",
+    "rollup-plugin-dts": "^6.1.1",
     "typescript": "^5.3.2"
   },
   "scripts": {
-    "build": "tsc -b tsconfig.json tsconfig.esm.json",
+    "build": "tsc -b tsconfig.json tsconfig.esm.json && npm run build:dts-bundles",
+    "build:dts-bundles": "test -f config/rollup-config.js && rollup --config config/rollup-config.js || echo 'Warning: config/rollup-config.js not found!'",
     "test": ":"
   },
   "wix": {
@@ -37,5 +43,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "136ed5ae36ef6f1f16f20a8ee7de14674e50825da7a4769c7d4a8690"
+  "falconPackageHash": "679ed5c0c092341d244fecd00369348a1e592f40bd2b7019176fb7bb"
 }

package/type-bundles/context.bundle.d.ts

@@ -0,0 +1,483 @@
+/** Physical address */
+interface Address extends AddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number as free text. */
+    addressLine1?: string | null;
+    /** Country code. */
+    country?: string | null;
+    /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
+    subdivision?: string | null;
+    /** City name. */
+    city?: string | null;
+    /** Zip/postal code. */
+    postalCode?: string | null;
+    /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
+    addressLine2?: string | null;
+}
+/** @oneof */
+interface AddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number as free text. */
+    addressLine?: string | null;
+}
+interface StreetAddress {
+    /** Street number. */
+    number?: string;
+    /** Street name. */
+    name?: string;
+}
+interface PageLink {
+    /** The page id we want from the site */
+    pageId?: string;
+    /** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
+    target?: string | null;
+    /** rel of link */
+    rel?: LinkRel[];
+}
+/**
+ * The 'rel' attribute of the link. The rel attribute defines the relationship between a linked resource and the current document.
+ * Further reading (also about different possible rel types): https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel
+ * Following are the accepted 'rel' types by Wix applications.
+ */
+declare enum LinkRel {
+    /** default (not implemented) */
+    unknown_link_rel = "unknown_link_rel",
+    /** Indicates that the current document's original author or publisher does not endorse the referenced document. */
+    nofollow = "nofollow",
+    /** Instructs the browser to navigate to the target resource without granting the new browsing context access to the document that opened it. */
+    noopener = "noopener",
+    /** No Referer header will be included. Additionally, has the same effect as noopener. */
+    noreferrer = "noreferrer",
+    /** Indicates a link that resulted from advertisements or paid placements. */
+    sponsored = "sponsored"
+}
+interface Variant {
+    name?: string;
+    value?: string;
+    image?: string;
+}
+interface MyAddress {
+    country?: string | null;
+    subdivision?: string | null;
+    city?: string | null;
+    postalCode?: string | null;
+    streetAddress?: StreetAddress;
+}
+interface GetProductsStartWithResponse {
+    products?: Product[];
+}
+interface Cursors {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+interface BulkCreateProductsResponse {
+    results?: BulkProductResult[];
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkProductResult {
+    /** Defined in wix.commons */
+    itemMetadata?: ItemMetadata;
+    /** Only exists if `returnEntity` was set to true in the request */
+    item?: Product;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface MaskedProduct {
+    /** Product to be updated, may be partial */
+    product?: Product;
+}
+interface BulkUpdateProductsResponse {
+    results?: BulkUpdateProductsResponseBulkProductResult[];
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkUpdateProductsResponseBulkProductResult {
+    itemMetadata?: ItemMetadata;
+    /** Only exists if `returnEntity` was set to true in the request */
+    item?: Product;
+}
+interface BulkDeleteProductsResponse {
+    results?: BulkDeleteProductsResponseBulkProductResult[];
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkDeleteProductsResponseBulkProductResult {
+    itemMetadata?: ItemMetadata;
+}
+interface GetProductsStartWithResponseNonNullableFields {
+    products: {
+        _id: string;
+        collectionId: string;
+        image: string;
+        document: string;
+        video: string;
+        pageLink?: {
+            pageId: string;
+            rel: LinkRel[];
+        };
+        audio: string;
+        variants: {
+            name: string;
+            value: string;
+            image: string;
+        }[];
+        mainVariant?: {
+            name: string;
+            value: string;
+            image: string;
+        };
+        guid: string;
+    }[];
+}
+interface BulkCreateProductsResponseNonNullableFields {
+    results: {
+        itemMetadata?: {
+            originalIndex: number;
+            success: boolean;
+            error?: {
+                code: string;
+                description: string;
+            };
+        };
+        item?: {
+            _id: string;
+            collectionId: string;
+            image: string;
+            document: string;
+            video: string;
+            pageLink?: {
+                pageId: string;
+                rel: LinkRel[];
+            };
+            audio: string;
+            variants: {
+                name: string;
+                value: string;
+                image: string;
+            }[];
+            mainVariant?: {
+                name: string;
+                value: string;
+                image: string;
+            };
+            guid: string;
+        };
+    }[];
+    bulkActionMetadata?: {
+        totalSuccesses: number;
+        totalFailures: number;
+        undetailedFailures: number;
+    };
+}
+interface BulkUpdateProductsResponseNonNullableFields {
+    results: {
+        itemMetadata?: {
+            originalIndex: number;
+            success: boolean;
+            error?: {
+                code: string;
+                description: string;
+            };
+        };
+        item?: {
+            _id: string;
+            collectionId: string;
+            image: string;
+            document: string;
+            video: string;
+            pageLink?: {
+                pageId: string;
+                rel: LinkRel[];
+            };
+            audio: string;
+            variants: {
+                name: string;
+                value: string;
+                image: string;
+            }[];
+            mainVariant?: {
+                name: string;
+                value: string;
+                image: string;
+            };
+            guid: string;
+        };
+    }[];
+    bulkActionMetadata?: {
+        totalSuccesses: number;
+        totalFailures: number;
+        undetailedFailures: number;
+    };
+}
+interface BulkDeleteProductsResponseNonNullableFields {
+    results: {
+        itemMetadata?: {
+            originalIndex: number;
+            success: boolean;
+            error?: {
+                code: string;
+                description: string;
+            };
+        };
+    }[];
+    bulkActionMetadata?: {
+        totalSuccesses: number;
+        totalFailures: number;
+        undetailedFailures: number;
+    };
+}
+interface Product {
+    _id: string;
+    name: string | null;
+    collectionId: string;
+    _createdDate: Date;
+    modifiedDate: Date;
+    image: string;
+    address: Address;
+    document: string;
+    video: string;
+    pageLink: PageLink;
+    audio: string;
+    color: string | null;
+    localDate: string | null;
+    localTime: string | null;
+    localDateTime: string | null;
+    variants: Variant[];
+    mainVariant: Variant;
+    customAddress: MyAddress;
+    guid: string;
+}
+interface CreateProductOptions {
+    product?: Product;
+}
+interface UpdateProductOptions {
+    product?: Product;
+}
+interface GetProductsStartWithOptions {
+    addressLine2?: string | null;
+}
+interface QueryProductsOptions {
+    /** Whether variants should be included in the response. */
+    includeVariants?: boolean | undefined;
+    /** Whether hidden products should be included in the response. Requires permissions to manage products. */
+    includeHiddenProducts?: boolean | undefined;
+    /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
+    includeMerchantSpecificData?: boolean | undefined;
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface ProductsQueryResult extends QueryCursorResult {
+    items: Product[];
+    query: ProductsQueryBuilder;
+    next: () => Promise<ProductsQueryResult>;
+    prev: () => Promise<ProductsQueryResult>;
+}
+interface ProductsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: 'title' | 'collectionId' | 'guid', value: any) => ProductsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: 'title' | 'guid', value: any) => ProductsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: 'title' | 'guid', value: string) => ProductsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: 'title' | 'guid', value: any[]) => ProductsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: 'title' | 'guid', value: any) => ProductsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: 'title' | 'guid', value: boolean) => ProductsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'title' | 'collectionId' | 'guid'>) => ProductsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'title' | 'collectionId' | 'guid'>) => ProductsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => ProductsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => ProductsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<ProductsQueryResult>;
+}
+interface BulkCreateProductsOptions {
+    /** set to `true` if you wish to receive back the created products in the response */
+    returnEntity?: boolean;
+}
+interface BulkUpdateProductsOptions {
+    /** set to `true` if you wish to receive back the updated products in the response */
+    returnEntity?: boolean;
+}
+
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+
+declare function createProduct$1(httpClient: HttpClient): (options?: CreateProductOptions) => Promise<Product & {
+    _id: string;
+    collectionId: string;
+    image: string;
+    document: string;
+    video: string;
+    pageLink?: {
+        pageId: string;
+        rel: LinkRel[];
+    } | undefined;
+    audio: string;
+    variants: {
+        name: string;
+        value: string;
+        image: string;
+    }[];
+    mainVariant?: {
+        name: string;
+        value: string;
+        image: string;
+    } | undefined;
+    guid: string;
+}>;
+declare function deleteProduct$1(httpClient: HttpClient): (productId: string) => Promise<void>;
+declare function updateProduct$1(httpClient: HttpClient): (productId: string, options?: UpdateProductOptions) => Promise<Product & {
+    _id: string;
+    collectionId: string;
+    image: string;
+    document: string;
+    video: string;
+    pageLink?: {
+        pageId: string;
+        rel: LinkRel[];
+    } | undefined;
+    audio: string;
+    variants: {
+        name: string;
+        value: string;
+        image: string;
+    }[];
+    mainVariant?: {
+        name: string;
+        value: string;
+        image: string;
+    } | undefined;
+    guid: string;
+}>;
+declare function getProduct$1(httpClient: HttpClient): (productId: string) => Promise<Product & {
+    _id: string;
+    collectionId: string;
+    image: string;
+    document: string;
+    video: string;
+    pageLink?: {
+        pageId: string;
+        rel: LinkRel[];
+    } | undefined;
+    audio: string;
+    variants: {
+        name: string;
+        value: string;
+        image: string;
+    }[];
+    mainVariant?: {
+        name: string;
+        value: string;
+        image: string;
+    } | undefined;
+    guid: string;
+}>;
+declare function getProductsStartWith$1(httpClient: HttpClient): (title: string, options?: GetProductsStartWithOptions) => Promise<GetProductsStartWithResponse & GetProductsStartWithResponseNonNullableFields>;
+declare function queryProducts$1(httpClient: HttpClient): (options?: QueryProductsOptions) => ProductsQueryBuilder;
+declare function bulkCreateProducts$1(httpClient: HttpClient): (products: Product[], options?: BulkCreateProductsOptions) => Promise<BulkCreateProductsResponse & BulkCreateProductsResponseNonNullableFields>;
+declare function bulkUpdateProducts$1(httpClient: HttpClient): (products: MaskedProduct[], options?: BulkUpdateProductsOptions) => Promise<BulkUpdateProductsResponse & BulkUpdateProductsResponseNonNullableFields>;
+declare function bulkDeleteProducts$1(httpClient: HttpClient): (productIds: string[]) => Promise<BulkDeleteProductsResponse & BulkDeleteProductsResponseNonNullableFields>;
+
+declare const createProduct: BuildRESTFunction<typeof createProduct$1>;
+declare const deleteProduct: BuildRESTFunction<typeof deleteProduct$1>;
+declare const updateProduct: BuildRESTFunction<typeof updateProduct$1>;
+declare const getProduct: BuildRESTFunction<typeof getProduct$1>;
+declare const getProductsStartWith: BuildRESTFunction<typeof getProductsStartWith$1>;
+declare const queryProducts: BuildRESTFunction<typeof queryProducts$1>;
+declare const bulkCreateProducts: BuildRESTFunction<typeof bulkCreateProducts$1>;
+declare const bulkUpdateProducts: BuildRESTFunction<typeof bulkUpdateProducts$1>;
+declare const bulkDeleteProducts: BuildRESTFunction<typeof bulkDeleteProducts$1>;
+
+declare const context_bulkCreateProducts: typeof bulkCreateProducts;
+declare const context_bulkDeleteProducts: typeof bulkDeleteProducts;
+declare const context_bulkUpdateProducts: typeof bulkUpdateProducts;
+declare const context_createProduct: typeof createProduct;
+declare const context_deleteProduct: typeof deleteProduct;
+declare const context_getProduct: typeof getProduct;
+declare const context_getProductsStartWith: typeof getProductsStartWith;
+declare const context_queryProducts: typeof queryProducts;
+declare const context_updateProduct: typeof updateProduct;
+declare namespace context {
+  export { context_bulkCreateProducts as bulkCreateProducts, context_bulkDeleteProducts as bulkDeleteProducts, context_bulkUpdateProducts as bulkUpdateProducts, context_createProduct as createProduct, context_deleteProduct as deleteProduct, context_getProduct as getProduct, context_getProductsStartWith as getProductsStartWith, context_queryProducts as queryProducts, context_updateProduct as updateProduct };
+}
+
+export { context as products };