@wix/stores 1.0.959 → 1.0.960

package/build/internal/cjs/context-category-list-context-provider.d.ts

@@ -0,0 +1,101 @@
+import React from 'react';
+
+//#region ../../node_modules/type-fest/source/observable-like.d.ts
+declare global {
+  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+  interface SymbolConstructor {
+    readonly observable: symbol;
+  }
+}
+/**
+@remarks
+The TC39 observable proposal defines a `closed` property, but some implementations (such as xstream) do not as of 10/08/2021.
+As well, some guidance on making an `Observable` to not include `closed` property.
+@see https://github.com/tc39/proposal-observable/blob/master/src/Observable.js#L129-L130
+@see https://github.com/staltz/xstream/blob/6c22580c1d84d69773ee4b0905df44ad464955b3/src/index.ts#L79-L85
+@see https://github.com/benlesh/symbol-observable#making-an-object-observable
+
+@category Observable
+*/
+//#endregion
+//#region ../../node_modules/@wix/sdk-types/internal/build/index.d.ts
+declare global {
+  interface ContextualClient {}
+}
+/**
+ * Creates concrete types from SDK descriptors when a contextual client is
+ * available.
+ *
+ * For a REST descriptor the built (bound) API is intersected with the original
+ * descriptor, matching what `contextualizeRESTModuleV2` returns at runtime — a
+ * value callable as the bound API and still usable as a descriptor. Keeping the
+ * descriptor half lets contextual modules be passed to descriptor-constrained
+ * helpers such as `elevate` from `@wix/sdk/context` (FEDINF-14092).
+ *
+ * The `& T` is scoped to REST descriptors — the only shape codegen wraps in
+ * `MaybeContext` — so `BuildDescriptors` (used by `createClient().use`) is left
+ * unchanged and stays bound-only. The fix lives here rather than in `elevate`,
+ * which is kept strict on purpose (see #941) so it still rejects bound-only
+ * functions that are unsafe through `createRESTModule`.
+ */
+declare global {
+  /**
+   * A global interface to set the exposure toggle for the SDK.
+   * @example
+   * ```ts
+   * declare global {
+   *  interface SDKExposureToggle {
+   *    alpha: true;
+   *  }
+   * }
+   */
+  interface SDKExposureToggle {}
+}
+declare global {
+  /**
+   * A global interface to set the type mode for the SDK.
+   * @example
+   * ```ts
+   * declare global {
+   *  interface SDKTypeMode {
+   *    strict: true;
+   *  }
+   * }
+   */
+  interface SDKTypeMode {}
+}
+//#endregion
+//#region src/domain/category/category-node/category-node.d.ts
+interface CategoryNode {
+  id: string | null | undefined;
+  name?: string | null | undefined;
+  slug?: string | null | undefined;
+  href: string;
+  parentCategoryId?: string | null | undefined;
+  sortIndex?: number | null | undefined;
+  childCategoryIds: string[];
+}
+type CategoryNodes = Partial<Record<string, CategoryNode>>;
+//#endregion
+//#region src/extensions/gallery/providers/category-list-context/contract.d.ts
+interface CategoryListContextValue {
+  /** All visible store categories, keyed by category id. */
+  categories: CategoryNodes;
+  /** Id of the current category, or `undefined` when there is none. */
+  currentCategoryId: string | undefined;
+}
+//#endregion
+//#region src/extensions/gallery/providers/category-list-context/category-list-context-provider.d.ts
+/** Reads the visible store categories and the current category. */
+declare function useCategoryListContext(): CategoryListContextValue;
+/** Props accepted by {@link CategoryListContextProvider}. */
+interface CategoryListContextProviderProps extends React.PropsWithChildren {
+  value: CategoryListContextValue;
+}
+/** Supplies the category list and current category to descendant components. */
+declare function CategoryListContextProvider({
+  children,
+  value
+}: CategoryListContextProviderProps): React.ReactNode;
+
+export { CategoryListContextProvider, type CategoryListContextProviderProps, type CategoryListContextValue, CategoryListContextProvider as default, useCategoryListContext };